ServiceAccounts

This document uses the REST API. For more details, see the Authentication for API page.

Create a service account for an organization.

post

Create a service account for an organization. The service account can be used to access the Snyk API.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstring · uuidRequired

The ID of the Snyk Organization that is creating and will own the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

201

A new service account has been created

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/orgs/{org_id}/service_accounts

HTTPcURLJavaScriptPython

POST /rest/orgs/{org_id}/service_accounts?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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 a list of organization service accounts.

get

Get all service accounts for an organization.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstring · uuidRequired

The ID of the Snyk Organization that owns the service accounts.

Query parameters

starting_afterstringOptional

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestringOptional

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Responses

200

A list of service accounts is returned.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/service_accounts

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/service_accounts?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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 an organization service account.

patch

Update the name of an organization-level service account by its ID.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstring · uuidRequired

The ID of the Snyk Organization that owns the service account.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

200

Service account is returned.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/orgs/{org_id}/service_accounts/{serviceaccount_id}

HTTPcURLJavaScriptPython

PATCH /rest/orgs/{org_id}/service_accounts/{serviceaccount_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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 service account.

get

Get an organization-level service account by its ID.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstring · uuidRequired

The ID of the Snyk Organization that owns the service account.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Responses

200

Service account is returned.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/service_accounts/{serviceaccount_id}

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/service_accounts/{serviceaccount_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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.

delete

Delete a service account in an organization.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstring · uuidRequired

The ID of org to which the service account belongs.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Responses

204

The service account has been deleted.

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

delete

/orgs/{org_id}/service_accounts/{serviceaccount_id}

HTTPcURLJavaScriptPython

DELETE /rest/orgs/{org_id}/service_accounts/{serviceaccount_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Manage an organization service account's client secret.

post

Manage the client secret of an organization service account by the service account ID.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstring · uuidRequired

The ID of the Snyk Organization that owns the service account.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

200

Service account client secret has been updated.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets

HTTPcURLJavaScriptPython

POST /rest/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Create a service account for a group. The service account can be used to access the Snyk API.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

group_idstring · uuidRequired

The ID of the Snyk Group that is creating and owns the service account

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

201

A new service account has been created

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/groups/{group_id}/service_accounts

HTTPcURLJavaScriptPython

POST /rest/groups/{group_id}/service_accounts?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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 a list of group service accounts.

get

Get all service accounts for a group.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

group_idstring · uuidRequired

The ID of the Snyk Group that owns the service accounts.

Query parameters

starting_afterstringOptional

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestringOptional

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger · int32 · min: 10 · max: 100Optional

Number of results to return per page

Default: 10Example: 10

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Responses

200

A list of service accounts is returned.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/service_accounts

HTTPcURLJavaScriptPython

GET /rest/groups/{group_id}/service_accounts?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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 a group service account.

patch

Update the name of a group's service account by its ID.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

group_idstring · uuidRequired

The ID of the Snyk Group that owns the service account.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

200

Service account is returned.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/groups/{group_id}/service_accounts/{serviceaccount_id}

HTTPcURLJavaScriptPython

PATCH /rest/groups/{group_id}/service_accounts/{serviceaccount_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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 service account.

get

Get a group-level service account by its ID.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

group_idstring · uuidRequired

The ID of the Snyk Group that owns the service account.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Responses

200

Service account is returned.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/service_accounts/{serviceaccount_id}

HTTPcURLJavaScriptPython

GET /rest/groups/{group_id}/service_accounts/{serviceaccount_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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 group service account.

delete

Permanently delete a group-level service account by its ID.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

group_idstring · uuidRequired

The ID of the Snyk Group that owns the service account.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Responses

204

Service account was successfully deleted.

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

delete

/groups/{group_id}/service_accounts/{serviceaccount_id}

HTTPcURLJavaScriptPython

DELETE /rest/groups/{group_id}/service_accounts/{serviceaccount_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Manage a group service account's client secret.

post

Manage the client secret of a group service account by the service account ID.

Authorizations

BearerAuthAPIToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

group_idstring · uuidRequired

The ID of the Snyk Group that owns the service account.

serviceaccount_idstring · uuidRequired

The ID of the service account.

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

200

Service account client secret has been updated.

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets

HTTPcURLJavaScriptPython

POST /rest/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets?version=text HTTP/1.1
Host: api.snyk.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
  }
}