更新外部金鑰

POST/v1/organizations/external_keys/{external_key_id}

部分更新外部金鑰設定。省略的欄位保持不變。

display_name 一律可編輯。一旦有任何工作區參照此設定，geo 和 provider_config 便無法變更，因為先前加密的資料需要原始金鑰身分才能解密。

Path parameters

external_key_id: string

ID of the External Key.

maxLength2048

Body

display_name: optional string or null

Human-friendly display name.

maxLength255

minLength1

geo: optional "us" or null

Data residency geo. Only us is supported.

provider_config: optional object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more } or null

KMS provider identity and auth coordinates.

One of the following:

Aws 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 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 through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.

Gcp object{ key_name, type }

key_name: string

Full resource name of the Cloud KMS key.

type: "gcp"

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

Returns

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: object{ type } or object{ 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:

Attached object{ type }

type: "attached"

defaultattached

Unattached object{ type }

type: "unattached"

defaultunattached

created_at: string

formatdate-time

display_name: string or null

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: object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more }

KMS provider identity and auth coordinates.

One of the following:

Aws 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 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 through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.

Gcp object{ key_name, type }

key_name: string

Full resource name of the Cloud KMS key.

type: "gcp"

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

type: "external_key"

defaultexternal_key

updated_at: string

formatdate-time

更新外部金鑰

cURL

curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
    -d '{}'

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"
}

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"
}