ServiceAccounts

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

Create a service account for an organization.

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

POSThttps://api.snyk.io/rest/orgs/{org_id}/service_accounts

Path parameters

org_id*string (uuid)

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

Query parameters

Body

application/vnd.api+json

data*object

Response

201400401404500

A new service account has been created

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/service_accounts?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "name": "text",
          "role_id": "123e4567-e89b-12d3-a456-426614174000",
          "auth_type": "api_key"
        }
      }
    }),
});
const data = await response.json();

Response

201400401404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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 all service accounts for an organization.

GEThttps://api.snyk.io/rest/orgs/{org_id}/service_accounts

Path parameters

org_id*string (uuid)

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

Query parameters

Response

200400401403404500

A list of service accounts is returned.

Headers

Body

application/vnd.api+json

data*array of ServiceAccount (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/service_accounts?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "access_token_ttl_seconds": 0,
        "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.

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

PATCHhttps://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}

Path parameters

org_id*string (uuid)

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

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Body

application/vnd.api+json

data*object

Response

200400401403404500

Service account is returned.

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "service_account",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "attributes": {
          "name": "text"
        }
      }
    }),
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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 an organization-level service account by its ID.

GEThttps://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}

Path parameters

org_id*string (uuid)

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

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Response

200400401403404500

Service account is returned.

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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 a service account in an organization.

DELETEhttps://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}

Path parameters

org_id*string (uuid)

The ID of org to which the service account belongs.

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Response

204400401403404500

The service account has been deleted.

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Manage an organization service account's client secret.

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

POSThttps://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets

Path parameters

org_id*string (uuid)

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

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Body

application/vnd.api+json

data*object

Response

200400401403404500

Service account client secret has been updated.

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

linksLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "mode": "replace"
        },
        "type": "service_account"
      }
    }),
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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.

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

POSThttps://api.snyk.io/rest/groups/{group_id}/service_accounts

Path parameters

group_id*string (uuid)

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

Query parameters

Body

application/vnd.api+json

data*object

Response

201400401404500

A new service account has been created

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

linksLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/service_accounts?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "service_account",
        "attributes": {
          "name": "text",
          "auth_type": "api_key",
          "role_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }),
});
const data = await response.json();

Response

201400401404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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 all service accounts for a group.

GEThttps://api.snyk.io/rest/groups/{group_id}/service_accounts

Path parameters

group_id*string (uuid)

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

Query parameters

Response

200400401403404500

A list of service accounts is returned.

Headers

Body

application/vnd.api+json

data*array of ServiceAccount (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/service_accounts?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "access_token_ttl_seconds": 0,
        "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.

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

PATCHhttps://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}

Path parameters

group_id*string (uuid)

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

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Body

application/vnd.api+json

data*object

Response

200400401403404500

Service account is returned.

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "service_account",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "attributes": {
          "name": "text"
        }
      }
    }),
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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 a group-level service account by its ID.

GEThttps://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}

Path parameters

group_id*string (uuid)

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

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Response

200400401403404500

Service account is returned.

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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.

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

DELETEhttps://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}

Path parameters

group_id*string (uuid)

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

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Response

204400401403404500

Service account was successfully deleted.

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Manage a group service account's client secret.

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

POSThttps://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets

Path parameters

group_id*string (uuid)

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

serviceaccount_id*string (uuid)

The ID of the service account.

Query parameters

Body

application/vnd.api+json

data*object

Response

200400401403404500

Service account client secret has been updated.

Headers

Body

application/vnd.api+json

data*ServiceAccount (object)

jsonapi*JsonApi (object)

linksLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "mode": "replace"
        },
        "type": "service_account"
      }
    }),
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "access_token_ttl_seconds": 0,
      "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"
  }
}