Claude Platform Docs

API 키

API 키 목록 조회
ApiKeyListPage organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
API 키 조회 (Admin API)
ApiKey organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys/{api_key_id}

조직 내 단일 API 키에 대한 정보를 ID로 조회합니다. 이 Admin API 엔드포인트는 Admin API 키가 필요하고, 프로그래밍 방식의 키 관리를 위한 것이며, 키의 비밀 값은 절대 반환하지 않습니다. 자신의 API 키를 보거나 생성하려면 Claude Console의 API 키로 이동하세요.

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.