Service accounts

Service accounts are non-interactive machine identities used by agents and automation. Each service account is an organization member with the service_account role.

Use these endpoints to create, describe, update, and delete the service accounts of an organization, and to list the service accounts assigned to a workspace.

Path and query parameters

Name	Type	Location	Req/Opt	Description
orgId	integer	path	Required	Organization identifier.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
max	integer	query	Optional	Maximum number of results to return. Default: 20. Maximum: 100.
saId	integer	path	Required	Service account identifier.
workspaceId	integer	path	Required	Workspace identifier.
pageToken	string	query	Optional	Opaque cursor for the page to return. Omit for the first page; otherwise pass the nextPageToken from a previous response. An invalid token is rejected with 400.
pageSize	integer	query	Optional	Number of results to return per page. Must be between 1 and 100. Default: 50.

Request body parameters

Name	Type	Req/Opt	Description
CreateServiceAccount			Create service account
description	string	Optional	Optional description of the service account and what it automates. Maximum 1000 characters.
name	string	Required	Service account name. Must be unique across all Platform users. Maximum 40 characters.
UpdateServiceAccount			Update service account
description	string	Optional	Updated description of the service account. Maximum 1000 characters.
name	string	Optional	Updated service account name. Must be unique across all Platform users. Maximum 40 characters.