外部金鑰

建立外部金鑰

BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)

POST/v1/organizations/external_keys

建立由呼叫者組織所擁有的外部金鑰設定。

列出外部金鑰

ExternalKeyListPage Beta.Organization.ExternalKeys.List(parameters, cancellationToken = default)

GET/v1/organizations/external_keys

列出呼叫者組織中的外部金鑰設定。

取得外部金鑰

BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)

GET/v1/organizations/external_keys/{external_key_id}

依 ID 擷取呼叫者組織中的單一外部金鑰設定。

更新外部金鑰

BetaExternalKey Beta.Organization.ExternalKeys.Update(parameters, cancellationToken = default)

POST/v1/organizations/external_keys/{external_key_id}

部分更新外部金鑰設定。省略的欄位保持不變。

刪除外部金鑰

ExternalKeyDeleteResponse Beta.Organization.ExternalKeys.Delete(parameters, cancellationToken = default)

DELETE/v1/organizations/external_keys/{external_key_id}

刪除外部金鑰設定。

驗證外部金鑰

ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)

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

針對客戶的 KMS 驗證外部金鑰設定。

Models

class BetaAwsExternalKeyConfig { Type = "aws"; KmsArn; Region; RoleArn; }

JsonElement Type = "aws"

required 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

string? Region

AWS region. Derived from kms_arn if omitted.

string? RoleArn⁠Deprecated

IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.

class BetaAzureExternalKeyConfig { Type = "azure"; KeyName; TenantID; /* 2 more */ }

JsonElement Type = "azure"

required string KeyName

Name of the key within the vault.

required string TenantID

Azure AD tenant ID.

required string VaultUri

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

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 BetaAzureExternalKeyConfigParam { Type = "azure"; KeyName; TenantID; /* 2 more */ }

Azure Key Vault provider configuration.

JsonElement Type = "azure"

required string KeyName

Name of the key within the vault.

required string TenantID

Azure AD tenant ID.

required string VaultUri

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

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 BetaExternalKey { 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 BetaExternalKeyAttachedAttachment { Type = "attached"; }

JsonElement Type = "attached"

class BetaExternalKeyUnattachedAttachment { Type = "unattached"; }

JsonElement Type = "unattached"

class BetaGcpExternalKeyConfig { Type = "gcp"; KeyName; }

JsonElement Type = "gcp"

required string KeyName

Full resource name of the Cloud KMS key.