Update External Key

$ ant beta:organization:external-keys update

POST/v1/organizations/external_keys/{external_key_id}

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

display_name is always editable. geo and provider_config cannot be changed once any workspace references this config, because previously encrypted data requires the original key identity to decrypt.

Parameters

--external-key-id: string

ID of the External Key.

maxLength2048

--display-name: optional string

Human-friendly display name.

maxLength255

minLength1

--geo: optional "us"

Data residency geo. Only us is supported.

--provider-config: optional BetaAWSExternalKeyConfig { kms_arn, type, region, role_arn } or BetaGCPExternalKeyConfig { key_name, type } or BetaAzureExternalKeyConfigParam { key_name, tenant_id, type, 2 more }

KMS provider identity and auth coordinates.

Returns

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

id: string

Identifier of the external key config. A tagged ID prefixed ekey_, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.

attachment: BetaExternalKeyAttachedAttachment { type } or BetaExternalKeyUnattachedAttachment { type }

Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an unattached config is inert and can be deleted.

One of the following:

beta_external_key_attached_attachment: object{ type }

type: "attached"

beta_external_key_unattached_attachment: object{ type }

type: "unattached"

created_at: string

formatdate-time

display_name: string

Human-friendly display name. Null if none was set.

geo: string

Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.

provider_config: BetaAWSExternalKeyConfig { kms_arn, type, region, role_arn } or BetaGCPExternalKeyConfig { key_name, type } or BetaAzureExternalKeyConfig { key_name, tenant_id, type, 2 more }

KMS provider identity and auth coordinates.

One of the following:

beta_aws_external_key_config: object{ kms_arn, type, region, role_arn }

kms_arn: string

Full ARN of the AWS KMS key.

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 via a managed intermediate role; this field is ignored.

beta_gcp_external_key_config: object{ key_name, type }

key_name: string

Full resource name of the Cloud KMS key.

type: "gcp"

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.

type: "external_key"

updated_at: string

formatdate-time

Update External Key

ant beta:organization:external-keys update \
  --api-key my-anthropic-api-key \
  --external-key-id external_key_id

{
  "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
  "attachment": {
    "type": "attached"
  },
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_name": "prod-us-key",
  "geo": "us",
  "provider_config": {
    "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
    "type": "aws",
    "region": "us-east-1",
    "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
  },
  "type": "external_key",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}

Returns Examples

{
  "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
  "attachment": {
    "type": "attached"
  },
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_name": "prod-us-key",
  "geo": "us",
  "provider_config": {
    "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
    "type": "aws",
    "region": "us-east-1",
    "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
  },
  "type": "external_key",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}