外部キー

外部キーを作成

ExternalKey organization().externalKeys().create(params, requestOptions = RequestOptions.none())

POST/v1/organizations/external_keys

呼び出し元の組織が所有する外部キー設定を作成します。

外部キー一覧を取得

ExternalKeyListPage organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())

GET/v1/organizations/external_keys

呼び出し元の組織内の外部キー設定を一覧表示します。

外部キーを取得

ExternalKey organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())

GET/v1/organizations/external_keys/{external_key_id}

呼び出し元の組織内の単一の外部キー設定をIDで取得します。

外部キーを更新

ExternalKey organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())

POST/v1/organizations/external_keys/{external_key_id}

外部キー設定を部分的に更新します。省略されたフィールドは変更されません。

外部キーを削除

ExternalKeyDeleteResponse organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())

DELETE/v1/organizations/external_keys/{external_key_id}

外部キー設定を削除します。

外部キーを検証

ExternalKeyValidateResponse organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())

POST/v1/organizations/external_keys/{external_key_id}/validate

顧客のKMSに対して外部キー設定を検証します。

Models

class AwsExternalKeyConfig { type = "aws"; kmsArn; region; }

JsonValue type = "aws"

String kmsArn

Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.

maxLength2048

Optional<String> region

AWS region. Derived from kms_arn if omitted.

class AzureExternalKeyConfig { type = "azure"; keyName; tenantId; /* 2 more */ }

JsonValue type = "azure"

String keyName

Name of the key within the vault.

String tenantId

Azure AD tenant ID.

String vaultUri

Key Vault data-plane URI — https://{vault-name}.vault.azure.net or https://{hsm-name}.managedhsm.azure.net.

Optional<String> clientId

Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.

class AzureExternalKeyConfigParam { type = "azure"; keyName; tenantId; /* 2 more */ }

Azure Key Vault provider configuration.

JsonValue type = "azure"

String keyName

Name of the key within the vault.

String tenantId

Azure AD tenant ID.

String vaultUri

Key Vault data-plane URI — https://{vault-name}.vault.azure.net or https://{hsm-name}.managedhsm.azure.net.

Optional<String> clientId

Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.

class ExternalKey { type = "external_key"; id; attachment; /* 5 more */ }

CMEK external key config belonging to the caller's organization.

Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).

class ExternalKeyAttachedAttachment { type = "attached"; }

JsonValue type = "attached"

class ExternalKeyUnattachedAttachment { type = "unattached"; }

JsonValue type = "unattached"

class GcpExternalKeyConfig { type = "gcp"; keyName; }

JsonValue type = "gcp"

String keyName

Full resource name of the Cloud KMS key.