Claude Platform Docs

External Keys

Create External Key
beta.organization.external_keys.create(**kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys

Create an external key config owned by the caller's organization.

List External Keys
beta.organization.external_keys.list(**kwargs) -> SyncPageCursor[BetaExternalKey]
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}

Retrieve a single external key config in the caller's organization by ID.

Update External Key
beta.organization.external_keys.update(external_key_id, **kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}

Partially update an external key config. Omitted fields are left unchanged.

Delete External Key
beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

Validate an external key config against the customer's KMS.

Models
class BetaAWSExternalKeyConfig: type: "aws"; kms_arn; region; role_arn
type: Literal["aws"]
kms_arn: str

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
region: Optional[str]

AWS region. Derived from kms_arn if omitted.

role_arn: Optional[str]⁠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"; key_name; tenant_id; ... # 2 more
type: Literal["azure"]
key_name: str

Name of the key within the vault.

tenant_id: str

Azure AD tenant ID.

vault_uri: str

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

client_id: Optional[str]

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"; key_name; tenant_id; ... # 2 more

Azure Key Vault provider configuration.

type: Literal["azure"]
key_name: str

Name of the key within the vault.

tenant_id: str

Azure AD tenant ID.

vault_uri: str

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

client_id: Optional[str]

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"
type: Literal["attached"]
defaultattached
class BetaExternalKeyUnattachedAttachment: type: "unattached"
type: Literal["unattached"]
defaultunattached
class BetaGCPExternalKeyConfig: type: "gcp"; key_name
type: Literal["gcp"]
key_name: str

Full resource name of the Cloud KMS key.

class ExternalKeyDeleteResponse: type: "external_key_deleted"; id
type: Literal["external_key_deleted"]
defaultexternal_key_deleted
id: str

ID of the deleted External Key.

class ExternalKeyValidateResponse: type: "external_key_validation"; error; status

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

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

type: Literal["external_key_validation"]
defaultexternal_key_validation
error: Optional[str]

Error message when status is failure. Null otherwise.

status: Literal["failure", "success"]

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

One of the following:
"failure"
"success"