Ключи API

Список ключей API

ApiKeyListPage beta().organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())

GET/v1/organizations/api_keys

Получить ключ API (Admin API)

BetaApiKey beta().organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())

GET/v1/organizations/api_keys/{api_key_id}

Возвращает информацию об одном ключе API в вашей организации по его идентификатору. Эта конечная точка Admin API требует ключа Admin API, предназначена для программного управления ключами и никогда не возвращает секретное значение ключа. Чтобы просмотреть или создать собственные ключи API, перейдите в раздел Ключи API в Claude Console.

Обновить ключ API

BetaApiKey beta().organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())

POST/v1/organizations/api_keys/{api_key_id}

Models

class BetaApiKey { type = "api_key"; id; createdAt; /* 8 more */ }

class BetaApiKeyCreatedBy { type; id; }

Type type

Type of the actor that created the object.

One of the following:

SERVICE_ACCOUNT("service_account")

USER("user")

String id

ID of the actor that created the object.

class BetaApiKeyOrganizationScope { type = "organization"; }

JsonValue 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; }

JsonValue type = "service_account_actor"

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

String serviceAccountId

ID of the Service Account the API key acts as.

class BetaApiKeyUserActor { type = "user_actor"; userId; }

JsonValue type = "user_actor"

Principal type. Always "user_actor" for a User.

String userId

ID of the User the API key acts as.

class BetaApiKeyWorkspaceScope { type = "workspace"; workspaceId; }

JsonValue type = "workspace"

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

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.