Claude Platform Docs

API 金鑰

列出 API 金鑰
$ ant organization:api-keys list
GET/v1/organizations/api_keys
擷取 API 金鑰(Admin API)
$ ant organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}

依 ID 查詢並擷取您組織中單一 API 金鑰的資訊。此 Admin API 端點需要 Admin API 金鑰,適用於以程式方式管理金鑰,且絕不會傳回金鑰的秘密值。若要檢視或建立您自己的 API 金鑰,請前往 Claude Console 中的 API 金鑰。

更新 API 金鑰
$ ant organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}
Models
api_key: object{ type: "api_key", id, created_at, 7 more }
api_key_created_by: 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.

api_key_organization_scope: 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.

api_key_service_account_actor: object{ type: "service_account_actor", service_account_id }
type: "service_account_actor"

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

service_account_id: string

ID of the Service Account the API key acts as.

api_key_user_actor: object{ type: "user_actor", user_id }
type: "user_actor"

Principal type. Always "user_actor" for a User.

user_id: string

ID of the User the API key acts as.

api_key_workspace_scope: object{ type: "workspace", workspace_id }
type: "workspace"

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

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.