Claude Platform Docs

API 密钥

列出 API 密钥
client.Organization.APIKeys.List(ctx, query) (*Page[APIKey], error)
GET/v1/organizations/api_keys
检索 API 密钥(Admin API)
client.Organization.APIKeys.Get(ctx, apiKeyID) (*APIKey, error)
GET/v1/organizations/api_keys/{api_key_id}

按 ID 检索您组织中单个 API 密钥的信息。此 Admin API 端点需要 Admin API 密钥,用于以编程方式管理密钥,并且绝不会返回密钥的机密值。要查看或创建您自己的 API 密钥,请前往 Claude Console 中的 API 密钥页面。

更新 API 密钥
client.Organization.APIKeys.Update(ctx, apiKeyID, body) (*APIKey, error)
POST/v1/organizations/api_keys/{api_key_id}
Models
type APIKey struct { Type: "api_key"; ID; CreatedAt; /* 7 more */ }
type APIKeyCreatedBy struct { Type; ID }
Type APIKeyCreatedByType

Type of the actor that created the object.

One of the following:
const APIKeyCreatedByTypeServiceAccount APIKeyCreatedByType = "service_account"
const APIKeyCreatedByTypeUser APIKeyCreatedByType = "user"
ID string

ID of the actor that created the object.

type APIKeyOrganizationScope struct { 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
type APIKeyServiceAccountActor struct { Type: "service_account_actor"; ServiceAccountID }
Type ServiceAccountActor

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

defaultservice_account_actor
ServiceAccountID string

ID of the Service Account the API key acts as.

type APIKeyUserActor struct { Type: "user_actor"; UserID }
Type UserActor

Principal type. Always "user_actor" for a User.

defaultuser_actor
UserID string

ID of the User the API key acts as.

type APIKeyWorkspaceScope struct { Type: "workspace"; WorkspaceID }
Type Workspace

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

defaultworkspace
WorkspaceID 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.