Claude Platform Docs

API 金鑰

列出 API 金鑰
ApiKeyListPage Beta.Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
擷取 API 金鑰(Admin API)
BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 金鑰
BetaApiKey Beta.Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}
Models
class BetaApiKey { Type = "api_key"; ID; CreatedAt; /* 8 more */ }
class BetaApiKeyCreatedBy { Type; ID; }
required Type Type

Type of the actor that created the object.

One of the following:
ServiceAccount("service_account")
User("user")
required string ID

ID of the actor that created the object.

class BetaApiKeyOrganizationScope { Type = "organization"; }
JsonElement 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; }
JsonElement Type = "service_account_actor"

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

required string ServiceAccountID

ID of the Service Account the API key acts as.

class BetaApiKeyUserActor { Type = "user_actor"; UserID; }
JsonElement Type = "user_actor"

Principal type. Always "user_actor" for a User.

required string UserID

ID of the User the API key acts as.

class BetaApiKeyWorkspaceScope { Type = "workspace"; WorkspaceID; }
JsonElement Type = "workspace"

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

required 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.