API 金鑰 - Claude API Reference

列出 API 金鑰

GET/v1/organizations/api_keys

擷取 API 金鑰（Admin API）

GET/v1/organizations/api_keys/{api_key_id}

依 ID 查詢並擷取您組織中單一 API 金鑰的資訊。此 Admin API 端點需要 Admin API 金鑰，專為程式化金鑰管理而設計，且絕不會回傳金鑰的祕密值。若要檢視或建立您自己的 API 金鑰，請前往 Claude Console 中的 API 金鑰。

更新 API 金鑰

POST/v1/organizations/api_keys/{api_key_id}

Models

APIKey object{ type: "api_key", id, created_at, 8 more }

APIKeyCreatedBy object{ type, id }

type: "service_account" or "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.

APIKeyOrganizationScope object{ 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

APIKeyServiceAccountActor object{ 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.

APIKeyUserActor object{ 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.

APIKeyWorkspaceScope object{ 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.