You can set up a service account to be used for continuous integration (CI) and other automation purposes without using an actual Snyk user’s token. Service accounts are a special type of system user that has only an API token associated with it, substituting for standard user credentials. Use this token to provide credentials for accessing your Snyk account when setting up integration with your development tools and when working with our CLI and API. For more information about our APIs, see our API documentation.
You can generate single or multiple tokens on the organization or group levels to manage your integrations. Use group-level tokens to access group API endpoints, organization API endpoints, and the CLI—for all organizations within the group.
Each service account has a unique name associated with it to make it easier to recognize. The name is unique for the organization and cannot be re-used.
By using a service account token, you can:
- Create multiple tokens for different uses or integrations in order to manage each separately
- Ensure seamless integrations even when employees change roles or close their Snyk accounts, for example.
Generate single or multiple tokens on the organization or group levels to manage your integrations.
This feature is available with Enterprise plans. See Pricing plans for more details.
To create a group service account you must be a group admin. To create an org service account you must be an org admin or a group admin.
This process describes all options.
- Log in to your account and navigate to the relevant group and organization that you want to manage.
- Click on settings > Service accounts to view existing service accounts and their details.
- Click Create a service account to create a new one. The screen that loads varies a little, depending on if you chose a group (left) or an organization (right):
- From the Service Account name field, enter a unique name for this token. Remember this name can be used only once for tokens in the same area, either per organization or per group.
- From the Role dropdown list, select Viewer or Admin to configure the scope of the token:
Viewer enables read-only access.
- Admin enables full administrator access.
- Click Create. The token is generated and displayed from the same area, similar to the following:
Make sure you copy this token as you won’t see it again. You can click Close and Hide once you've copied the token; either way, when you navigate away from this page it will no longer be accessible. This is a security standard to keep your tokens safe. The new token is also added to your Existing service accounts list, similar to the following image:
Furthermore, if you created the token for the entire group with an Admin role, the token also appears in the Existing service accounts list for each of its organizations, though it can only be edited from the Group level.
If you created the token from an organization that is part of a group, the token now also appears in the Existing service account list on the group level, where the group admin can also change the token name or even delete it.
- Click any of the links to update the names for a service account token - for Group-level tokens, from the Group level only; for Organization-level tokens, from the relevant organization and also from the Group level:
- Repeat these steps to create multiple tokens for the same or any other organization or group.
Administrators can change token names and delete tokens. When you delete a service account, the API token associated with it becomes immediately invalidated. When an account is managed with groups, the organization and the group admins can delete tokens for the organization; only group admins can view and manage tokens on the group level. Deleting a service account is the same as revoking the API token.
Log in to your account and navigate to the relevant group and organization that you want to manage.
For group tokens, navigate to the group level. For organization tokens, group admins can delete from either the group or the relevant organization; organization admins should navigate to the relevant organization.
Click on settings > Service accounts.
Scroll to find the list of existing service accounts:
From the list of existing tokens:
Click Delete to delete a token and invalidate it immediately. When prompted, click OK. Remember that you cannot re-generate the same token!
Click the token name to navigate to change the token name and click Save.