Service Accounts

Create

POST/organizations/{organization_id}/service-accounts

List

GET/organizations/{organization_id}/service-accounts

Retrieve

GET/organizations/{organization_id}/service-accounts/{service_account_id}

Update

PATCH/organizations/{organization_id}/service-accounts/{service_account_id}

Delete

DELETE/organizations/{organization_id}/service-accounts/{service_account_id}

ModelsExpand Collapse

ServiceAccount = object { id, created_at, name, 3 more }

id: string

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1

maxLength255

created_at: string

The time the entity was created in utc

formatdate-time

name: string

A name for the entity to be displayed in UI

updated_at: string

The time the entity was mostly recently updated in utc

formatdate-time

description: optional string

Optional description of the service account

permissions: optional map[map[boolean]]

Permissions granted to the authenticated principal for this resource. Only populated when the 'expand[]=permissions' query parameter is provided. Keys are resource types (e.g., "organizations"), values are objects mapping permission names to boolean values indicating if the permission is granted.

Service AccountsCredentials

Create

POST/organizations/{organization_id}/service-accounts/{service_account_id}/credentials

List

GET/organizations/{organization_id}/service-accounts/{service_account_id}/credentials

Retrieve

GET/organizations/{organization_id}/service-accounts/{service_account_id}/credentials/{credential_id}

Update

PATCH/organizations/{organization_id}/service-accounts/{service_account_id}/credentials/{credential_id}

Delete

DELETE/organizations/{organization_id}/service-accounts/{service_account_id}/credentials/{credential_id}

ModelsExpand Collapse

ServiceAccountCredential = object { id, client_id, created_at, 4 more }

Service account credential (without secret)

id: string

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1

maxLength255

client_id: string

The client ID for authentication

created_at: string

The time the entity was created in utc

formatdate-time

name: string

A name for the entity to be displayed in UI

description: optional string

Optional description of the credential

last_used_at: optional string

When the credential was last used

formatdate-time

permissions: optional map[map[boolean]]