Chaves de API

Listar chaves de API

client.organization.apiKeys.list(query?, options?): Page<APIKey>

GET/v1/organizations/api_keys

Recuperar chave de API (Admin API)

client.organization.apiKeys.retrieve(apiKeyID, options?): APIKey

GET/v1/organizations/api_keys/{api_key_id}

Recupere informações sobre uma única chave de API em sua organização, pesquisada pelo ID. Este endpoint da Admin API requer uma chave de Admin API, destina-se ao gerenciamento programático de chaves e nunca retorna o valor secreto da chave. Para visualizar ou criar suas próprias chaves de API, acesse Chaves de API no Claude Console.

Atualizar chave de API

client.organization.apiKeys.update(apiKeyID, body, options?): APIKey

POST/v1/organizations/api_keys/{api_key_id}

Models

interface APIKey { type: "api_key"; id; created_at; /* 7 more */ }

interface APIKeyCreatedBy { type; id }

type: "service_account" | "user"

Type of the actor that created the object.

One of the following:

"service_account"

"user"

id: string

ID of the actor that created the object.

interface APIKeyOrganizationScope { type: "organization" }

type: "organization"

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

defaultorganization

interface APIKeyServiceAccountActor { type: "service_account_actor"; service_account_id }

type: "service_account_actor"

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

defaultservice_account_actor

service_account_id: string

ID of the Service Account the API key acts as.

interface APIKeyUserActor { type: "user_actor"; user_id }

type: "user_actor"

Principal type. Always "user_actor" for a User.

defaultuser_actor

user_id: string

ID of the User the API key acts as.

interface APIKeyWorkspaceScope { type: "workspace"; workspace_id }

type: "workspace"

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

defaultworkspace

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.