> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Snyk

> How to set up the Snyk connector, plus the actions and events that are available.

![Snyk](https://stackone-logos.com/api/snyk/filled/svg)

v3.0.1[See changelog](https://docs.stackone.com/connectors/snyk/changelog.md)

[86 actions](#actions) · [2 events](#events) · 4 auth methods

Developer Tools
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Auth Token · Connector Profile](https://docs.stackone.com/connectors/snyk/guides/connector-profile/auth-token.md)
>
> Uses your Snyk account Auth Token — the token shown under Account settings > General — sent in the Authorization header...

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/snyk/guides/connector-profile/personal-access-token.md)
>
> Uses a Snyk Personal Access Token (PAT) — created under Account settings > Personal Access Tokens — sent in the Authoriz...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/snyk/guides/connector-profile/oauth-2-0.md)
>
> Uses a Snyk App OAuth 2.0 authorization code grant. Requires registering a Snyk App via the Snyk REST API (using an exis...

> [card] [OAuth 2.0 (Service Account) · Connector Profile](https://docs.stackone.com/connectors/snyk/guides/connector-profile/oauth-2-0-service-account.md)
>
> Uses a Snyk Group or Organization service account, authenticated with the OAuth 2.0 client credentials grant — machine-t...

Optionally, configure receiving Events for Snyk into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/snyk/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Auth Token · Link Account](https://docs.stackone.com/connectors/snyk/guides/link-account/auth-token.md)

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/snyk/guides/link-account/personal-access-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/snyk/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Service Account) · Link Account](https://docs.stackone.com/connectors/snyk/guides/link-account/oauth-2-0-service-account.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Auth Token

OAuth 2.0

OAuth 2.0 (Service Account)

Personal Access Token

No auth methods found

Scopes

Select all
|
Clear

org.collection.create

org.collection.delete

org.collection.edit

org.collection.read

org.edit

org.project.delete

org.project.edit

org.project.read

org.read

No scopes found

86 actions

ActionDescriptionRequired scopes

List Group Audit Logs`snyk_list_group_audit_logs`

Search the audit log for a Snyk group, returning security-relevant events (membership changes, setting updates, project...

List Organization Audit Logs`snyk_list_organization_audit_logs`

Search the audit log for a single organization, returning security-relevant events. Filter by event type, actor, project...

List Collections`snyk_list_collections`

List the project collections in an organization. Collections are user-defined groupings of projects used to organize and...

`org.collection.read`

Create Collection`snyk_create_collection`

Create a new project collection in an organization. Provide the organization ID and a name for the collection.

`org.collection.create`

Get Collection`snyk_get_collection`

Retrieve a single project collection by ID, including its name and metadata. Provide the organization ID and collection...

`org.collection.read`

Update Collection`snyk_update_collection`

Rename a project collection. Provide the organization ID, the collection ID, and the new name.

`org.collection.edit`

Delete Collection`snyk_delete_collection`

Delete a project collection. This removes the grouping only; the underlying projects are not deleted. Provide the organi...

`org.collection.delete`

List Collection Projects`snyk_list_collection_projects`

List the projects that belong to a collection. Provide the organization ID and collection ID; supports the same project...

`org.collection.read`

Add Projects To Collection`snyk_add_collection_projects`

Add one or more projects to a collection. Provide the organization ID, the collection ID, and the list of project IDs to...

`org.collection.edit`

Remove Projects From Collection`snyk_remove_collection_projects`

Remove one or more projects from a collection. Provide the organization ID, the collection ID, and the list of project I...

`org.collection.edit`

List Groups`snyk_list_groups`

List the Snyk groups the authenticated account can access. Groups sit above organizations in the Snyk hierarchy and own...

List Group Memberships`snyk_list_group_memberships`

List the members of a Snyk group and their group-level roles. Provide the group ID.

Add Group Member`snyk_create_group_membership`

Add a user to a Snyk group with a specific group role. Provide the group ID, the user ID, and the group role ID.

Update Group Member Role`snyk_update_group_membership`

Change the group role assigned to an existing group member. Provide the group ID, the membership ID, and the new group r...

Remove Group Member`snyk_delete_group_membership`

Remove a member from a Snyk group. Provide the group ID and the membership ID.

List Group User Org Memberships`snyk_list_group_user_org_memberships`

List, across all organizations in a group, the org-level memberships of the group's users. Use this to see which organiz...

List Group SSO Connections`snyk_list_group_sso_connections`

List the SSO (single sign-on) connections configured for a Snyk group. Provide the group ID.

List SSO Connection Users`snyk_list_group_sso_connection_users`

List the users provisioned through a specific SSO connection in a group. Provide the group ID and SSO connection ID.

Remove SSO Connection User`snyk_remove_sso_connection_user`

Remove a user from a group's SSO connection. Provide the group ID, the SSO connection ID, and the user ID.

Get Unified Credentials`snyk_unified_get_me`

Get the current Snyk connection's unified credentials and identity.

List Unified Groups`snyk_unified_list_groups`

List unified groups in a Snyk Group.

Get Unified Group`snyk_unified_get_group`

Get a unified Snyk Organization by ID.

List Unified Organizations`snyk_unified_list_organizations`

List unified organizations in Snyk.

Get Unified Organization`snyk_unified_get_organization`

Get a unified Snyk Group by ID.

List Unified Roles`snyk_unified_list_roles`

List unified roles in a Snyk Group.

Get Unified Role`snyk_unified_get_role`

Get a unified Snyk Group role by ID.

List Unified Users`snyk_unified_list_users`

List unified users in a Snyk Group.

Get Unified User`snyk_unified_get_user`

Get a unified Snyk Group user by ID.

List Invitations`snyk_list_invitations`

List the pending invitations to join an organization. Provide the organization ID.

Create Invitation`snyk_create_invitation`

Invite a user to join an organization by email with a specific role. Provide the organization ID, the invitee's email, a...

Delete Invitation`snyk_delete_invitation`

Revoke a pending organization invitation. Provide the organization ID and the invitation ID.

List Group Issues`snyk_list_group_issues`

List security issues (vulnerabilities, license problems, code, cloud, and config findings) aggregated across all organiz...

Get Group Issue`snyk_get_group_issue`

Retrieve a single security issue by ID at the group level, including its severity, type, and affected item. Provide the...

List Organization Issues`snyk_list_organization_issues`

List security issues found in a Snyk organization — vulnerabilities, license, code, cloud, config, and secrets findings....

Get Organization Issue`snyk_get_organization_issue`

Retrieve a single security issue by ID within an organization, including full detail on the vulnerability and the affect...

List Issues For Packages`snyk_list_issues_for_purls`

Look up known issues for many packages at once by their Package URLs (purls). Provide the organization ID and a list of...

List Issues For Package`snyk_list_issues_for_package`

Look up known issues for a single package by its Package URL (purl). Provide the organization ID and the purl; returns t...

List Group Organizations`snyk_list_group_organizations`

List the organizations that belong to a specific group. Provide the group ID; returns each organization Snyk manages und...

List Organizations`snyk_list_organizations`

List all Snyk organizations the authenticated user or service account can access. Supports filtering by group, name, slu...

`org.read`

Get Organization`snyk_get_organization`

Retrieve a single Snyk organization by its ID, including its name, slug, and group association.

`org.read`

Update Organization`snyk_update_organization`

Update a Snyk organization's settings, such as its display name. Provide the organization ID and the attributes to chang...

`org.edit`

List Organization Memberships`snyk_list_organization_memberships`

List the user and service-account memberships in an organization, including each member's assigned role. Use this to aud...

Add Organization Member`snyk_create_organization_membership`

Add a user to a Snyk organization with a specific role. Provide the organization ID, the user ID, and the org role ID to...

Update Organization Member Role`snyk_update_organization_membership`

Change the role assigned to an existing organization member. Provide the organization ID, the membership ID, and the new\...

Remove Organization Member`snyk_delete_organization_membership`

Remove a member from a Snyk organization, revoking their access. Provide the organization ID and the membership ID.

List Group Policies`snyk_list_group_policies`

List the policies defined at the group level. Snyk policies automate actions on issues — for example ignoring or re-prio...

Create Group Policy`snyk_create_group_policy`

Create a group-level policy that automatically applies an action to issues matching its conditions. Provide the group ID...

Update Group Policy`snyk_update_group_policy`

Update a group-level policy's name, conditions, or action. Provide the group ID and policy ID.

Delete Group Policy`snyk_delete_group_policy`

Delete a group-level policy. Provide the group ID and policy ID.

List Organization Policies`snyk_list_organization_policies`

List the policies defined at the organization level. Provide the organization ID.

Create Organization Policy`snyk_create_organization_policy`

Create an organization-level policy that automatically applies an action to issues matching its conditions. Provide the...

Get Organization Policy`snyk_get_organization_policy`

Retrieve a single organization-level policy by ID, including its conditions and action. Provide the organization ID and...

Update Organization Policy`snyk_update_organization_policy`

Update an organization-level policy's name, conditions, action, or review setting. Provide the organization ID and polic...

Delete Organization Policy`snyk_delete_organization_policy`

Delete an organization-level policy. Provide the organization ID and policy ID.

List Organization Policy Events`snyk_list_organization_policy_events`

List the events (applications and changes) recorded for an organization-level policy. Provide the organization ID and po...

List Projects`snyk_list_projects`

List the monitored projects in a Snyk organization. Projects are the scanned targets (repositories, images, packages) wh...

`org.project.read`

Get Project`snyk_get_project`

Retrieve a single monitored project by ID, including its target, settings, and metadata. Provide the organization ID and...

`org.project.read`

Update Project`snyk_update_project`

Update a project's attributes such as tags, environment, lifecycle, business criticality, or test frequency. Provide the...

`org.project.edit`

Delete Project`snyk_delete_project`

Delete a single monitored project, permanently stopping Snyk from tracking it. Provide the organization ID and project I...

`org.project.delete`

List Group Roles`snyk_list_group_roles`

List the roles defined in a Snyk group, with their IDs, names and descriptions. Provide the group ID.

Get Project SBOM`snyk_get_project_sbom`

Generate a Software Bill of Materials (SBOM) for a monitored project, listing all its dependencies in CycloneDX or SPDX...

Create SBOM Test`snyk_create_sbom_test`

Submit an SBOM document to be tested for known vulnerabilities. Provide the organization ID, the SBOM format, and the SB...

Get SBOM Test Status`snyk_get_sbom_test_status`

Check the status of a submitted SBOM test job. Provide the organization ID and job ID.

Get SBOM Test Results`snyk_get_sbom_test_results`

Retrieve the results of a completed SBOM test job, listing the vulnerabilities found in the submitted SBOM. Provide the...

List Group Service Accounts`snyk_list_group_service_accounts`

List the service accounts defined at the group level. Service accounts provide machine credentials for automation agains...

Create Group Service Account`snyk_create_group_service_account`

Create a group-level service account for API automation. Provide the group ID, a name, the group role ID, and the authen...

Get Group Service Account`snyk_get_group_service_account`

Retrieve a single group-level service account by ID. Provide the group ID and service account ID.

Update Group Service Account`snyk_update_group_service_account`

Update a group-level service account, such as renaming it. Provide the group ID and service account ID.

Delete Group Service Account`snyk_delete_group_service_account`

Delete a group-level service account, revoking its credentials. Provide the group ID and service account ID.

Update Group Service Account Secret`snyk_update_group_service_account_secret`

Rotate, create, or delete the secret of a group-level service account. Provide the group ID, service account ID, and the...

List Organization Service Accounts`snyk_list_organization_service_accounts`

List the service accounts defined at the organization level. Provide the organization ID.

Create Organization Service Account`snyk_create_organization_service_account`

Create an organization-level service account for API automation. Provide the organization ID, a name, the org role ID, a...

Get Organization Service Account`snyk_get_organization_service_account`

Retrieve a single organization-level service account by ID. Provide the organization ID and service account ID.

Update Organization Service Account`snyk_update_organization_service_account`

Update an organization-level service account, such as renaming it. Provide the organization ID and service account ID.

Delete Organization Service Account`snyk_delete_organization_service_account`

Delete an organization-level service account, revoking its credentials. Provide the organization ID and service account...

Update Organization Service Account Secret`snyk_update_organization_service_account_secret`

Rotate, create, or delete the secret of an organization-level service account. Provide the organization ID, service acco...

List Targets`snyk_list_targets`

List the scan targets in an organization. A target is the source Snyk imports projects from — for example a Git reposito...

Get Target`snyk_get_target`

Retrieve a single scan target by ID, including its source integration and display name. Provide the organization ID and...

Delete Target`snyk_delete_target`

Delete a scan target and all of its associated projects from an organization. Provide the organization ID and target ID....

List Tenants`snyk_list_tenants`

List the Snyk tenants the authenticated account belongs to. Use this to find the tenant ID that tenant memberships and t...

List Tenant Memberships`snyk_list_tenant_memberships`

List the members of a Snyk tenant with their tenant-level roles, including whether each account is active. Set account\_t...

List Tenant Roles`snyk_list_tenant_roles`

List the roles available in a Snyk tenant, with their permissions and how many users, service accounts and apps hold eac...

Get Tenant Role`snyk_get_tenant_role`

Retrieve a single role of a Snyk tenant by ID, including its permissions. Provide the tenant ID and role ID.

Get User`snyk_get_user`

Retrieve a single user's profile within an organization by user ID. Provide the organization ID and user ID.

Get Current User`snyk_get_current_user`

Retrieve the profile of the currently authenticated user or service account, including the user ID, name, email, and def...

List Pending User Provisions`snyk_list_pending_user_provisions`

List the people provisioned to a Snyk Organization ahead of their first SSO sign-in. Provide the Organization ID.

## Events

Tags

Select all
|
Clear

Projects

Webhooks

No tags found

2 events

EventDescriptionTags

Project Snapshot`snyk_webhook_project_snapshot`

Emitted every time an existing Snyk project is tested and a new snapshot is created, whether or not there are new issues...

ProjectsWebhooks

Ping`snyk_webhook_ping`

Acknowledges the Snyk webhook ping handshake (`ping`), sent when a webhook subscription is created and whenever the ping...

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.