Authentication for Visual Studio Code extension

To scan your Projects, you must authenticate with Snyk.

Snyk supports the following protocols for authentication:

• OAuth 2.0 (default)

• Snyk API token (fallback option)

For both methods, Snyk uses the Secret Storage API to store the token securely. This storage uses the system's keychain to manage the token.

Steps to authenticate using the OAuth 2.0 protocol

To authenticate, follow these steps:

1. After the extension is installed, click the Snyk Icon in the navigation bar, and then click Connect & Trust Workspace:

   
2. A new browser window opens; in response to the prompt, log in to your Snyk account.

3. In the next prompt, the Snyk IDE extension requests access to act on your behalf; click Grant app access.

4. When you have authenticated successfully, a confirmation message appears; close the browser window and return to the IDE.

5. The IDE reads and saves the authentication on your local machine. Close the browser window and return to the IDE.

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

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

Steps to authenticate using your Snyk API token

To authenticate, follow these steps:

1. After the extension is installed, click the Snyk Icon in the navigation bar; then click the Settings icon, find Authentication Method, and change it to Token authentication:

1. Copy your API token. For details, see Obtain and use your Snyk API token.

2. Run theSnyk: Set Token command and paste the token in the text field.

How to switch accounts

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

1. Run the provided Snyk: Log Out command.

1. 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.