Claude Platform Docs

Обновить внешний ключ

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

Частично обновляет конфигурацию внешнего ключа. Пропущенные поля остаются без изменений.

display_name всегда можно изменить. geo и provider_config нельзя изменить, если на эту конфигурацию ссылается хотя бы одно рабочее пространство, поскольку для расшифровки ранее зашифрованных данных требуется исходная идентичность ключа.

Parameters
external_key_id: String⁠Path parameter

ID of the External Key.

maxLength2048
display_name: String

Human-friendly display name.

minLength1
maxLength255
geo: :us

Data residency geo. Only us is supported.

provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfigParam

KMS provider identity and auth coordinates.

One of the following:
class BetaAWSExternalKeyConfig { type: :aws, kms_arn, region, role_arn }
type: :aws
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
region: String

AWS region. Derived from kms_arn if omitted.

role_arn: 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.

class BetaGCPExternalKeyConfig { type: :gcp, key_name }
type: :gcp
key_name: String

Full resource name of the Cloud KMS key.

class BetaAzureExternalKeyConfigParam { 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: 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
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).

Обновить внешний ключ
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_external_key = anthropic.beta.organization.external_keys.update("external_key_id")

puts(beta_external_key)
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"
}