Claude Platform Docs

Claves externas

Crear clave externa
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys
Listar claves externas
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys
Obtener clave externa
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}
Actualizar clave externa
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}
Eliminar clave externa
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}
Validar clave externa
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate
Models
beta_aws_external_key_config: object{ kms_arn, type, region, role_arn }
kms_arn: string

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
type: "aws"
region: optional string

AWS region. Derived from kms_arn if omitted.

role_arn: optional string⁠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.

beta_azure_external_key_config: 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

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.

beta_azure_external_key_config_param: 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

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.

beta_external_key: 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).

beta_external_key_attached_attachment: object{ type }
type: "attached"
beta_external_key_unattached_attachment: object{ type }
type: "unattached"
beta_gcp_external_key_config: object{ key_name, type }
key_name: string

Full resource name of the Cloud KMS key.

type: "gcp"