Chaves de API

Listar chaves de API

ApiKeyListPage Beta.Organization.ApiKeys.List(parameters, cancellationToken = default)

GET/v1/organizations/api_keys

Recuperar chave de API (Admin API)

BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)

GET/v1/organizations/api_keys/{api_key_id}

Recupere informações sobre uma única chave de API na sua organização, consultada pelo ID. Este endpoint da Admin API requer uma chave de API Admin, 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

BetaApiKey Beta.Organization.ApiKeys.Update(parameters, cancellationToken = default)

POST/v1/organizations/api_keys/{api_key_id}

Models

class BetaApiKey { Type = "api_key"; ID; CreatedAt; /* 8 more */ }

class BetaApiKeyCreatedBy { Type; ID; }

required Type Type

Type of the actor that created the object.

One of the following:

ServiceAccount("service_account")

User("user")

required string ID

ID of the actor that created the object.

class BetaApiKeyOrganizationScope { Type = "organization"; }

JsonElement Type = "organization"

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

class BetaApiKeyServiceAccountActor { Type = "service_account_actor"; ServiceAccountID; }

JsonElement Type = "service_account_actor"

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

required string ServiceAccountID

ID of the Service Account the API key acts as.

class BetaApiKeyUserActor { Type = "user_actor"; UserID; }

JsonElement Type = "user_actor"

Principal type. Always "user_actor" for a User.

required string UserID

ID of the User the API key acts as.

class BetaApiKeyWorkspaceScope { Type = "workspace"; WorkspaceID; }

JsonElement Type = "workspace"

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

required string WorkspaceID

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.