Skip to content
English
NopSec.com
  • There are no suggestions because the search field is empty.

Integrating Snyk (Code and Open Source)

Below are detailed instructions on how to create a Snyk API service account with view-only permission to groups.

 

Step 1: Log in to Your Snyk Account

Navigate to the Snyk website and log in with an account that has "Group Admin" privileges. This is necessary to create and manage service accounts at the group level.

Step 2: Navigate to Your Group's Settings

Once logged in, locate the group for which you want to create the service account. Click on the group name to enter the group's context. Then, in the left-hand navigation menu, click on Settings.

Step 3: Access Service Accounts

Within the "Settings" menu, find and click on Service accounts. This section is where you can create and manage API tokens for automated processes.

Step 4: Create a New Service Account

On the "Service accounts" page, click the Create service account button.

Step 5: Configure the Service Account

A dialog box will appear, prompting you to configure the new service account.

  • Name: Enter a descriptive name for your service account. It's a good practice to name it based on its purpose, for example, readonly-auditing-tool.
  • Role: This is the most crucial step for setting up view-only permissions. From the "Role" dropdown menu, select Group Viewer. This role grants read-only access to the group's information.

Step 6: Create and Copy the API Token

After filling in the name and selecting the "Group Viewer" role, click the Create button.

Snyk will generate a unique API token for the service account. This is the only time the token will be displayed. Make sure to copy it immediately and store it in a secure location, such as a password manager or a secure vault.

 

Step 7: Enable Integration in the Nopsec Platform

  1. Navigate to Integrations in the NopSec UI and select the option to add the Snyk integration
  2. Enter Integration Access Info: When prompted enter the following information and click the "Save and Connect" button:
  • Connection Name: Unique name for this integration
  • Snyk API Key: Paste the API Key generated in the steps above.
  • V1 API URL:  The base URL for the Snyk V1 API depends on your Snyk regional hosting and data residency, but the primary endpoints are: 
  • SNYK-US-01 (default): https://api.snyk.io/v1/
  • SNYK-US-02: https://api.us.snyk.io/v1/
  • SNYK-EU-01: https://api.eu.snyk.io/v1/
  • SNYK-AU-01: https://api.au.snyk.io/v1/ 
  • Snyk REST API: The base URL for the Snyk REST API is https://api.snyk.io/rest. For users in specific regions, the following base URLs are used:
  • SNYK-US-01: https://api.snyk.io/rest
  • SNYK-US-02: https://api.us.snyk.io/rest
  • SNYK-EU-01: https://api.eu.snyk.io/rest
  • SNYK-AU-01: https://api.au.snyk.io/rest