Snyk
Visualize Snyk code repositories and findings, and monitor changes through queries and alerts.
- Installation guide
- Snyk data model
Installation
Adding the SNyk integration instance in JupiterOne requires the following two parameters from Snyk:
Snyk API Key (
snykApiKey
): In Snyk, mouse over your account name in the upper right-hand corner, where a drop-down will appear. Click on Account Settings and your API token will appear in a hidden form in the middle of the page. Click Show and copy your key.Snyk Organisation ID (
snykOrgId
) In Snyk, go to the dashboard. Click on manage organisation on the far right of the screen across from Dashboard. Here, your Organisation ID is displayed.
Configuration in JupiterOne
To install the Snyk integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select Snyk. Click New Instance to begin configuring your integration.
Creating a configuration requires the following:
The Account Name used to identify the Snyk account in JupiterOne. Ingested entities will have this value stored in
tag.AccountName
when theAccountName
toggle is enabled.Description to assist in identifying the integration instance, if desired.
Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as
DISABLED
and manually execute the integration.Your Snyk API Key and Organisation ID.
Click Create once all values are provided to finalize the integration.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
Data Model
Entities
The following entities are created:
Resources | Entity _type | Entity _class |
---|---|---|
Snyk Account | snyk_account | Account |
Snyk Group | snyk_group | Group |
Snyk Issue | snyk_finding | Finding |
Snyk Organization | snyk_organization | Organization |
Snyk Project | snyk_project | Project |
Snyk Role | snyk_role | AccessRole |
Snyk Service | snyk_service | Service |
Snyk User | snyk_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
---|---|---|
snyk_account | HAS | snyk_group |
snyk_account | HAS | snyk_organization |
snyk_account | HAS | snyk_service |
snyk_group | HAS | snyk_organization |
snyk_group | HAS | snyk_role |
snyk_organization | HAS | snyk_project |
snyk_organization | HAS | snyk_role |
snyk_organization | HAS | snyk_user |
snyk_project | HAS | snyk_finding |
snyk_service | IDENTIFIED | snyk_finding |
snyk_service | SCANS | snyk_project |
snyk_user | ASSIGNED | snyk_role |
Mapped Relationships
The following mapped relationships are created:
Source Entity _type | Relationship _class | Target Entity _type | Direction |
---|---|---|---|
snyk_finding | IS | *cve* | FORWARD |
snyk_finding | EXPLOITS | *cwe* | FORWARD |