Snyk Apps
Snyk Apps are in beta and only an App’s developer (Snyk Organization) can install the Snyk App they created. Snyk wants to learn more about what the community needs before launching the Snyk App marketplace.
Snyk Apps are integrations that extend the functionality of the Snyk platform, allowing you to create a Snyk experience to suit your specific needs. For example, a Snyk App might automate Snyk’s application security testing as part of a build tool. Another Snyk App might stream Snyk’s security testing results into an incident management tool.
The easiest way to start building a new Snyk App is to clone the Demo Snyk Apps GitHub repository. See Quickstart: clone the Snyk demo app.
This document describes how to create a new Snyk App in the language of your choice, and can be used along with the API documentation (experimental) and Snyk OAuth2 API documentation.
The Snyk Apps platform uses an OAuth 2.0 authorization flow. This allows your Snyk App to get an access token to act on a users’ behalf, depending on the scopes you request. There are many OAuth 2.0 libraries available that will greatly simplify the integration. The Snyk Apps Demo uses the popular JavaScript library passport.js.
A Snyk App is set up to use a specific 'context' when creating the Snyk App, either 'tenant' or 'user'. This can be set with the
context field if creating a Snyk App with the API or the --context flag if using the CLI. If not specified a Snyk App will default to using the 'tenant' context, which should be prefered unless your Snyk App specifically needs to perform operations as an individual user.Authorizing a Snyk App that uses the 'user' context will grant the Snyk App access to perform actions on behalf of the user. The Snyk App will have access to the same set of Organizations and Groups as the installing user, as well as access to any new Organizations and Groups the user is added to. If at any point the installing user deactivates their account, any installed apps using the 'user' context that user has installed will not be able to request new access tokens.
When a user authorizes a Snyk App that uses the 'tenant' context, the user selects how to connect, to either an Organization (Org) or a Group (with access to either all or one of the Group's Orgs). The resulting connection is no longer tied to that specific user, so it is not bound by the user’s access or lifecycle but is linked to the Org’s lifecycle. For more information about Orgs see What’s a Snyk organization and for Groups, see What's a Snyk group.
The
scopes of an App determine which actions an App can perform while connected to a Snyk account. Currently, scopes are related to actions performed through Snyk Orgs, which determine the API endpoints that can be used in an App. Endpoints authorized through a Snyk Group are not yet supported. You can read more about scopes in Requesting scopes.The final step of the integration process is to get the ID of the Snyk organization the user has authorized. This ID is needed to use most API endpoints, so the App must associate it with your user's account/workspace for future use.
The easiest way to start building a new Snyk App is to clone the Demo Snyk Apps Github repository. You can either modify the demo to suit your App design or use it as a base for creating your own Snyk App.