Claude Platform Docs

API 密钥

列出 API 密钥
GET/v1/organizations/api_keys
检索 API 密钥(Admin API)
GET/v1/organizations/api_keys/{api_key_id}

检索您组织中单个 API 密钥的信息,按其 ID 查找。此 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.