Chaves de API

Listar chaves de API

client.Beta.Organization.APIKeys.List(ctx, query) (*Page[BetaAPIKey], error)

GET/v1/organizations/api_keys

Recuperar chave de API (Admin API)

client.Beta.Organization.APIKeys.Get(ctx, apiKeyID) (*BetaAPIKey, error)

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.Beta.Organization.APIKeys.Update(ctx, apiKeyID, body) (*BetaAPIKey, error)

POST/v1/organizations/api_keys/{api_key_id}

Models

type BetaAPIKey struct { Type: "api_key"; ID; CreatedAt; /* 8 more */ }

type BetaAPIKeyCreatedBy struct { Type; ID }

Type BetaAPIKeyCreatedByType

Type of the actor that created the object.

One of the following:

const BetaAPIKeyCreatedByTypeServiceAccount BetaAPIKeyCreatedByType = "service_account"

const BetaAPIKeyCreatedByTypeUser BetaAPIKeyCreatedByType = "user"

ID string

ID of the actor that created the object.

type BetaAPIKeyOrganizationScope struct { 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

type BetaAPIKeyServiceAccountActor struct { Type: "service_account_actor"; ServiceAccountID }

Type ServiceAccountActor

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

defaultservice_account_actor

ServiceAccountID string

ID of the Service Account the API key acts as.

type BetaAPIKeyUserActor struct { Type: "user_actor"; UserID }

Type UserActor

Principal type. Always "user_actor" for a User.

defaultuser_actor

UserID string

ID of the User the API key acts as.

type BetaAPIKeyWorkspaceScope struct { Type: "workspace"; WorkspaceID }

Type Workspace

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

defaultworkspace

WorkspaceID 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.