ServiceAccounts
Create a service account for an organization. The service account can be used to access the Snyk API.
Required permissions
Create service accounts (org.service_account.create)
The ID of the Snyk Organization that is creating and will own the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
POST /rest/orgs/{org_id}/service_accounts HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 182
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"auth_type": "api_key",
"jwks_url": "text",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"type": "service_account"
}
}
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Get all service accounts for an organization.
Required permissions
View service accounts (org.service_account.read)
The ID of the Snyk Organization that owns the service accounts.
Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=
Number of results to return per page
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
GET /rest/orgs/{org_id}/service_accounts HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Update the name of an organization-level service account by its ID.
Required permissions
Edit service accounts (org.service_account.edit)
The ID of the Snyk Organization that owns the service account.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
PATCH /rest/orgs/{org_id}/service_accounts/{serviceaccount_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 108
{
"data": {
"attributes": {
"name": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "service_account"
}
}
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Get an organization-level service account by its ID.
Required permissions
View service accounts (org.service_account.read)
The ID of the Snyk Organization that owns the service account.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
GET /rest/orgs/{org_id}/service_accounts/{serviceaccount_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Delete a service account in an organization.
Required permissions
Remove service accounts (org.service_account.delete)
The ID of org to which the service account belongs.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
DELETE /rest/orgs/{org_id}/service_accounts/{serviceaccount_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Manage the client secret of an organization service account by the service account ID.
Required permissions
Edit service accounts (org.service_account.edit)
The ID of the Snyk Organization that owns the service account.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
POST /rest/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 83
{
"data": {
"attributes": {
"mode": "replace",
"secret": "text"
},
"type": "service_account"
}
}
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Create a service account for a group. The service account can be used to access the Snyk API.
Required permissions
Create service accounts (group.service_account.create)
The ID of the Snyk Group that is creating and owns the service account
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
POST /rest/groups/{group_id}/service_accounts HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 182
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"auth_type": "api_key",
"jwks_url": "text",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"type": "service_account"
}
}
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Get all service accounts for a group.
Required permissions
View service accounts (group.service_account.read)
The ID of the Snyk Group that owns the service accounts.
Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=
Number of results to return per page
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
GET /rest/groups/{group_id}/service_accounts HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Update the name of a group's service account by its ID.
Required permissions
Edit service accounts (group.service_account.edit)
The ID of the Snyk Group that owns the service account.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
PATCH /rest/groups/{group_id}/service_accounts/{serviceaccount_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 108
{
"data": {
"attributes": {
"name": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "service_account"
}
}
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Get a group-level service account by its ID.
Required permissions
View service accounts (group.service_account.read)
The ID of the Snyk Group that owns the service account.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
GET /rest/groups/{group_id}/service_accounts/{serviceaccount_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Permanently delete a group-level service account by its ID.
Required permissions
Delete service accounts (group.service_account.delete)
The ID of the Snyk Group that owns the service account.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
DELETE /rest/groups/{group_id}/service_accounts/{serviceaccount_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Manage the client secret of a group service account by the service account ID.
Required permissions
Edit service accounts (group.service_account.edit)
The ID of the Snyk Group that owns the service account.
The ID of the service account.
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
POST /rest/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 83
{
"data": {
"attributes": {
"mode": "replace",
"secret": "text"
},
"type": "service_account"
}
}
{
"data": {
"attributes": {
"access_token_ttl_seconds": 1,
"api_key": "text",
"auth_type": "api_key",
"client_id": "text",
"client_secret": "text",
"jwks_url": "text",
"level": "Group",
"name": "text",
"role_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
},
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource",
"last": "https://example.com/api/resource",
"next": "https://example.com/api/resource",
"prev": "https://example.com/api/resource",
"related": "https://example.com/api/resource",
"self": "https://example.com/api/resource"
}
}
Last updated
Was this helpful?