Claude Platform Docs

Kunci API

Daftar Kunci API
ApiKeyListPage organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
Ambil Kunci API (Admin API)
ApiKey organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
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
ApiKey organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}
Models
class ApiKey { type = "api_key"; id; createdAt; /* 7 more */ }
class ApiKeyCreatedBy { type; id; }
Type type

Type of the actor that created the object.

One of the following:
SERVICE_ACCOUNT("service_account")
USER("user")
String id

ID of the actor that created the object.

class ApiKeyOrganizationScope { type = "organization"; }
JsonValue 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; }
JsonValue type = "service_account_actor"

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

String serviceAccountId

ID of the Service Account the API key acts as.

class ApiKeyUserActor { type = "user_actor"; userId; }
JsonValue type = "user_actor"

Principal type. Always "user_actor" for a User.

String userId

ID of the User the API key acts as.

class ApiKeyWorkspaceScope { type = "workspace"; workspaceId; }
JsonValue type = "workspace"

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

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.