Snyk integration

About

The Snyk integration connects a Snyk project to ControlMap. ControlMap saves the project as an asset and stores the issues Snyk reports for it, with each issue's title, severity and package type. This gives you evidence that your code and its dependencies are being scanned for vulnerabilities.

Each connection covers one Snyk project. The card is in the Vulnerability Scanners category.

Before you start

You need these three details from your Snyk account:

Setting up integrations from the client portal is part of the Pro plan. For details, see the Free, Essentials and Pro plans article.
The API token of your Snyk account.
The organization ID of your Snyk account.
The ID of the Snyk project you want to connect.

Connect Snyk

Go to Monitor › Integrations and select Add Integration.
Search for Snyk and select its card.

The Add Integration window with Snyk entered in the search box and the Snyk card showing

On the Connection step, under Configure Connection, fill in all four fields:
- Connection Name: a name for this connection.
- API Token: the API token of your Snyk account.
- Organization Id: the organization ID of your Snyk account.
- Project Id: the project ID of your Snyk account.

The Add Snyk setup page on the Connection step, with the four fields and the help panel on the right

Select Next: Checks. ControlMap uses your API token to confirm it works with Snyk.
Complete the remaining steps as described in the Connect an integration article.

The setup page also has a help panel on the right with an overview of Snyk and a link, Read this article on Support Portal.

What you'll see after connecting

When the connection is saved, its page opens. It shows the connection's name, category and status (Checking connection..., Connected, Disconnected or Connection status unavailable) and whether it is Running or Not Running. The Connection, Schedule, Watchers, Logs and Help tabs are described in the Connect an integration article.

On each scan, ControlMap saves the Snyk project as one asset and stores its issues with it.

Disconnect or change settings

To change settings or the schedule, go to Monitor › Integrations and open the Snyk card. ControlMap doesn't show the saved API token, so enter it again when you edit the Connection tab. See the Connect an integration article for the schedule, scans and Watchers.
To remove the connection, select the bin icon on its card and choose Yes. Deleting the integration also deletes all of its assets and their compliance status.