APIキー - Claude API Reference

APIキー一覧を取得

organization.api_keys.list(**kwargs) -> Page<APIKey>

GET/v1/organizations/api_keys

APIキーを取得（Admin API）

organization.api_keys.retrieve(api_key_id) -> APIKey

GET/v1/organizations/api_keys/{api_key_id}

組織内の単一のAPIキーに関する情報を、そのIDで検索して取得します。このAdmin APIエンドポイントにはAdmin APIキーが必要で、プログラムによるキー管理を目的としており、キーのシークレット値を返すことはありません。自分のAPIキーを表示または作成するには、Claude ConsoleのAPIキーにアクセスしてください。

APIキーを更新

organization.api_keys.update(api_key_id, **kwargs) -> APIKey

POST/v1/organizations/api_keys/{api_key_id}

Models

class APIKey { type: :api_key, id, created_at, 7 more }

class APIKeyCreatedBy { type, id }

type: :service_account | :user

Type of the actor that created the object.

One of the following:

:service_account

:user

id: String

ID of the actor that created the object.

class APIKeyOrganizationScope { type: :organization }

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, service_account_id }

type: :service_account_actor

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

service_account_id: String

ID of the Service Account the API key acts as.

class APIKeyUserActor { type: :user_actor, user_id }

type: :user_actor

Principal type. Always "user_actor" for a User.

user_id: String

ID of the User the API key acts as.

class APIKeyWorkspaceScope { type: :workspace, workspace_id }

type: :workspace

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

workspace_id: 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.