API Keys

List API Keys

$ ant beta:organization:api-keys list

GET/v1/organizations/api_keys

Get API Key

$ ant beta:organization:api-keys retrieve

GET/v1/organizations/api_keys/{api_key_id}

Update API Key

$ ant beta:organization:api-keys update

POST/v1/organizations/api_keys/{api_key_id}

Models

beta_api_key: object{ id, created_at, created_by, 8 more }

beta_api_key_created_by: object{ id, type }

id: string

ID of the actor that created the object.

type: "service_account" or "user"

Type of the actor that created the object.

One of the following:

"service_account"

"user"

beta_api_key_organization_scope: object{ type }

type: "organization"

Scope type. Always "organization": the API key has no Workspace. Only a principal-bound API key can have this scope.

beta_api_key_service_account_actor: object{ service_account_id, type }

service_account_id: string

ID of the Service Account the API key acts as.

type: "service_account_actor"

Principal type. Always "service_account_actor" for a Service Account.

beta_api_key_user_actor: object{ type, user_id }

type: "user_actor"

Principal type. Always "user_actor" for a User.

user_id: string

ID of the User the API key acts as.

beta_api_key_workspace_scope: object{ type, workspace_id }

type: "workspace"

Scope type. Always "workspace": the API key belongs to one Workspace.

workspace_id: string

ID of the Workspace the API key belongs to. Unlike the deprecated top-level workspace_id, this is the Workspace's real ID even for the organization's default Workspace.