Claude Platform Docs

External Keys

Create External Key
POST/v1/organizations/external_keys
List External Keys
GET/v1/organizations/external_keys
Get External Key
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
POST/v1/organizations/external_keys/{external_key_id}/validate
Models
BetaAWSExternalKeyConfig object{ kms_arn, type, region, role_arn }
kms_arn: string

Full ARN of the AWS KMS key.

maxLength2048
type: "aws"
region: optional string or null

AWS region. Derived from kms_arn if omitted.

role_arn: optional string or null⁠Deprecated

IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored.

BetaAzureExternalKeyConfig object{ key_name, tenant_id, type, 2 more }
key_name: string

Name of the key within the vault.

tenant_id: string

Azure AD tenant ID.

type: "azure"
vault_uri: string

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

client_id: optional string or null

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.

BetaAzureExternalKeyConfigParam object{ key_name, tenant_id, type, 2 more }

Azure Key Vault provider configuration.

key_name: string

Name of the key within the vault.

tenant_id: string

Azure AD tenant ID.

type: "azure"
vault_uri: string

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

client_id: optional string or null

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.

BetaExternalKey object{ id, attachment, created_at, 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).

BetaExternalKeyAttachedAttachment object{ type }
type: "attached"
defaultattached
BetaExternalKeyUnattachedAttachment object{ type }
type: "unattached"
defaultunattached
BetaGCPExternalKeyConfig object{ key_name, type }
key_name: string

Full resource name of the Cloud KMS key.

type: "gcp"
ExternalKeyDeleteResponse object{ id, type }
id: string

ID of the deleted External Key.

type: "external_key_deleted"
defaultexternal_key_deleted
ExternalKeyValidateResponse object{ error, status, type }

Result of a validation roundtrip against the customer's KMS.

HTTP 200 for both outcomes — the operation completed; status says whether the key works.

error: string or null

Error message when status is failure. Null otherwise.

status: "failure" or "success"

success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

One of the following:
"failure"
"success"
type: "external_key_validation"
defaultexternal_key_validation