API 金鑰

列出 API 金鑰

organization.api_keys.list(**kwargs) -> SyncPage[APIKey]

GET/v1/organizations/api_keys

擷取 API 金鑰（Admin API）

organization.api_keys.retrieve(api_key_id) -> APIKey

GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 金鑰

organization.api_keys.update(api_key_id, **kwargs) -> APIKey

POST/v1/organizations/api_keys/{api_key_id}

Models

class APIKey: type: "api_key"; id; created_at; ... # 7 more

class APIKeyCreatedBy: type; id

type: Literal["service_account", "user"]

Type of the actor that created the object.

One of the following:

"service_account"

"user"

id: str

ID of the actor that created the object.

class APIKeyOrganizationScope: type: "organization"

type: Literal["organization"]

Scope type. Always "organization": the API key has no Workspace. Only a principal-bound API key can have this scope.

defaultorganization

class APIKeyServiceAccountActor: type: "service_account_actor"; service_account_id

type: Literal["service_account_actor"]

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

defaultservice_account_actor

service_account_id: str

ID of the Service Account the API key acts as.

class APIKeyUserActor: type: "user_actor"; user_id

type: Literal["user_actor"]

Principal type. Always "user_actor" for a User.

defaultuser_actor

user_id: str

ID of the User the API key acts as.

class APIKeyWorkspaceScope: type: "workspace"; workspace_id

type: Literal["workspace"]

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

defaultworkspace

workspace_id: str

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.