Claude Platform Docs

外部キーを更新

$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}

外部キー設定を部分的に更新します。省略されたフィールドは変更されません。

display_nameは常に編集可能です。geoとprovider_configは、いずれかのワークスペースがこの設定を参照すると 変更できなくなります。以前に暗号化されたデータを復号するには、元のキーIDが必要なためです。

Parameters
--external-key-id: string⁠Path parameter

ID of the External Key.

maxLength2048
--display-name: optional string

Human-friendly display name.

minLength1
maxLength255
--geo: optional "us"

Data residency geo. Only us is supported.

KMS provider identity and auth coordinates.

One of the following:
beta_aws_external_key_config: object{ type: "aws", kms_arn, region, role_arn }
type: "aws"
kms_arn: string

Full ARN of the AWS KMS key. On Claude Platform on AWS, alias ARNs are rejected, and your organization's own key must be a single-Region key in your organization's AWS account.

maxLength2048
region: optional string

AWS region. Derived from kms_arn if omitted.

role_arn: optional string⁠Deprecated

IAM role ARN. Deprecated; this field is ignored.

beta_gcp_external_key_config: object{ type: "gcp", key_name }
type: "gcp"
key_name: string

Full resource name of the Cloud KMS key.

beta_azure_external_key_config_param: object{ type: "azure", key_name, tenant_id, 2 more }

Azure Key Vault provider configuration.

type: "azure"
key_name: string

Name of the key within the vault.

tenant_id: string

Azure AD tenant ID.

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.

Returns
beta_external_key: object{ type: "external_key", id, attachment, 6 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).

外部キーを更新
ant beta:organization:external-keys update \
  --external-key-id external_key_id
Returns Examples
Response 200
{
  "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",
  "user_profile_id": "uprof_01SDCCSbTxrXDpWc1phhtcfK"
}