Authentication for the JetBrains plugin

To scan your Projects, you must authenticate with Snyk.

Snyk supports the following protocols for authentication:

• OAuth 2.0 (Recommended)

• Personal Access Token

• Snyk API token (Legacy)

Before authenticating, ensure your region is properly set. For more details, see IDEs URLs.

Authentication methods available in the Snyk plugin in Jetbrains IDEs

Steps to authenticate using the OAuth 2.0 protocol

Follow the next steps to authenticate:

1. After the extension is installed, click the Snyk icon in the navigation bar, then click Trust project and scan.

Snyk icon and connect and trust

1. A new browser window opens, requiring you to log in to your Snyk account.

2. In the next prompt, the Snyk IDE plugin requests access to act on your behalf. Click Grant app access.

3. When you have authenticated successfully, a confirmation message appears. Close the browser window and return to the IDE.

The analysis starts automatically. The IDE reads and saves the authentication tokens on your local machine.

OAuth 2.0 tokens are not static and cannot be copied from the Snyk account page.

If you have problems, see OAuth 2.0 authentication does not work.

Steps to authenticate using your Personal Access Token

This method is inferior to the OAuth method.

The Personal Access Token (PAT) authentication is progressively rolled out to all Enterprise customers. To check if this feature is available for your Organization at this time, please reach out to your Snyk account team.

To authenticate using the Personal Access token, follow these steps:

1. Navigate to Settings > Tools > Snyk.

2. Set the Authentication Method to Use Personal Access Token.

   
3. Click the Connect IDE to Snyk button.

4. Create your Personal Access Token. For details, see the Authentication for API page.

5. Add the token in the Token field.

6. Click Apply and Close.

Steps to authenticate using your Snyk API token

This method is inferior to the OAuth method.

To authenticate, follow these steps:

1. In the JetBrains plugin, navigate to Settings > Tools > Snyk.

2. Set the Authentication Method to API token.

   
3. Click the Connect IDE to Snyk button.

4. Click Authenticate in the web browser window that opens.

   
5. The API token is automatically updated in the API Token field.

6. Click Apply or OK.

The analysis starts automatically.

Alternatively, copy the personal API token from your Snyk Web UI instance (default is https://app.snyk.io). Paste the token in the API Token field. For details, see Obtain and use your Snyk API token.

How to switch accounts

To re-authenticate with a different account, follow these steps:

1. In the JetBrains plugin, navigate to Settings > Tools > Snyk.

2. Clear the value of the Token field.

3. Click Apply or OK.

4. When you have logged out, start authentication again from the beginning.

Requirements for Linux and Unix

When authenticating with Snyk, users have the option to copy the authentication URL to their clipboard.

For Linux and Unix users, this requires the xclip or xsel utility to be installed.