Claude Platform Docs

Kunci API

Daftar Kunci API
beta.organization.api_keys.list(**kwargs) -> SyncPage[BetaAPIKey]
GET/v1/organizations/api_keys
Ambil Kunci API (Admin API)
beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}

Ambil informasi tentang satu kunci API di organisasi Anda, dicari berdasarkan ID-nya. Endpoint Admin API ini memerlukan kunci Admin API, ditujukan untuk pengelolaan kunci secara terprogram, dan tidak pernah mengembalikan nilai rahasia kunci. Untuk melihat atau membuat kunci API Anda sendiri, buka Kunci API di Claude Console.

Perbarui Kunci API
beta.organization.api_keys.update(api_key_id, **kwargs) -> BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}
Models
class BetaAPIKey: type: "api_key"; id; created_at; ... # 8 more
class BetaAPIKeyCreatedBy: 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 BetaAPIKeyOrganizationScope: 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 BetaAPIKeyServiceAccountActor: 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 BetaAPIKeyUserActor: 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 BetaAPIKeyWorkspaceScope: 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.