Service Accounts
user_jwt read:service_accountsAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:service_accounts
org_id*stringThe organization ID
uuidlimit?integerMaximum number of items to return, 1–200 (default 100)
int641 <= value <= 200100cursor?stringOpaque continuation token returned as next_cursor by a previous request
The page of service accounts
application/json- response
next_cursor?|The cursor for the next page, or null at the end.
service_accounts*array<>The service accounts.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/service-accounts'{ "next_cursor": "string", "service_accounts": [ { "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "live_key_count": 0, "name": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "org_permissions": [ "string" ], "roles": [ "string" ], "updated_at": "2019-08-24T14:15:22Z" } ]}Creates a named account for organization automation.
user_jwt write:service_accountsAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:service_accounts
org_id*stringThe organization ID
uuidapplication/json- body
description?|The service account purpose, or null when omitted.
name*stringThe service account name.
roles*array<string>The role identifiers to assign.
1 <= itemsThe created service account
application/json- response
archived_at?|When the service account was archived, or null.
date-timecreated_at*stringWhen the service account was created.
date-timecreated_by?|The user who created the service account, or null.
uuiddescription?|The optional description.
id*stringThe service account ID.
uuidlive_key_count*integerThe number of active API keys owned by the service account.
int64name*stringThe service account name.
org_id*stringThe organization ID.
uuidorg_permissions*array<string>The effective permissions granted by the roles.
roles*array<string>The assigned role identifiers.
updated_at*stringWhen the service account was last updated.
date-timecurl -X POST 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/service-accounts' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "roles": [ "string" ]}'{ "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "live_key_count": 0, "name": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "org_permissions": [ "string" ], "roles": [ "string" ], "updated_at": "2019-08-24T14:15:22Z"}user_jwt read:service_accountsAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:service_accounts
org_id*stringThe organization ID
uuidservice_account_id*stringThe service account ID
uuidThe service account
application/json- response
archived_at?|When the service account was archived, or null.
date-timecreated_at*stringWhen the service account was created.
date-timecreated_by?|The user who created the service account, or null.
uuiddescription?|The optional description.
id*stringThe service account ID.
uuidlive_key_count*integerThe number of active API keys owned by the service account.
int64name*stringThe service account name.
org_id*stringThe organization ID.
uuidorg_permissions*array<string>The effective permissions granted by the roles.
roles*array<string>The assigned role identifiers.
updated_at*stringWhen the service account was last updated.
date-timecurl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/service-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "live_key_count": 0, "name": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "org_permissions": [ "string" ], "roles": [ "string" ], "updated_at": "2019-08-24T14:15:22Z"}Updates the name, description, or complete role set. Narrowing roles may revoke API keys.
user_jwt write:service_accountsAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:service_accounts
org_id*stringThe organization ID
uuidservice_account_id*stringThe service account ID
uuidapplication/json- body
description?|The replacement description; null clears it.
name?|The replacement name.
roles?array<string>|The replacement role identifiers.
The service account
application/json- response
archived_at?|When the service account was archived, or null.
date-timecreated_at*stringWhen the service account was created.
date-timecreated_by?|The user who created the service account, or null.
uuiddescription?|The optional description.
id*stringThe service account ID.
uuidlive_key_count*integerThe number of active API keys owned by the service account.
int64name*stringThe service account name.
org_id*stringThe organization ID.
uuidorg_permissions*array<string>The effective permissions granted by the roles.
roles*array<string>The assigned role identifiers.
updated_at*stringWhen the service account was last updated.
date-timecurl -X PATCH 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/service-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'{ "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "live_key_count": 0, "name": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "org_permissions": [ "string" ], "roles": [ "string" ], "updated_at": "2019-08-24T14:15:22Z"}Archives the service account and revokes its active API keys.
user_jwt delete:service_accountsAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: delete:service_accounts
org_id*stringThe organization ID
uuidservice_account_id*stringThe service account ID
uuidService account archived
curl -X DELETE 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/service-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08'user_jwt write:service_accountsAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:service_accounts
org_id*stringThe organization ID
uuidservice_account_id*stringThe service account ID
uuidapplication/json- body
The same body as the update, previewed without applying it.
description?|The replacement description; null clears it.
name?|The replacement name.
roles?array<string>|The replacement role identifiers.
The change impact
application/json- response
revoked_api_keys*integerThe number of API keys the change would revoke.
int640 <= valuerevoked_preview_grants*integerThe number of preview grants the change would revoke.
int640 <= valuecurl -X POST 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/service-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/update-preview' \ -H 'Content-Type: application/json' \ -d '{}'{ "revoked_api_keys": 0, "revoked_preview_grants": 0}