Claude Platform Docs

API 金鑰

列出 API 金鑰
ApiKeyListPage Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
擷取 API 金鑰(Admin API)
ApiKey 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 金鑰
ApiKey Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}
Models
class ApiKey { Type = "api_key"; ID; CreatedAt; /* 7 more */ }
class ApiKeyCreatedBy { 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 ApiKeyOrganizationScope { 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 ApiKeyServiceAccountActor { 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 ApiKeyUserActor { 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 ApiKeyWorkspaceScope { 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, including when it is the organization's default Workspace.