Chaves externas

Criar chave externa

$ ant beta:organization:external-keys create

POST/v1/organizations/external_keys

Crie uma configuração de chave externa pertencente à organização do chamador.

Listar chaves externas

$ ant beta:organization:external-keys list

GET/v1/organizations/external_keys

Liste as configurações de chaves externas na organização do chamador.

Obter chave externa

$ ant beta:organization:external-keys retrieve

GET/v1/organizations/external_keys/{external_key_id}

Recupere uma única configuração de chave externa na organização do chamador pelo ID.

Atualizar chave externa

$ ant beta:organization:external-keys update

POST/v1/organizations/external_keys/{external_key_id}

Atualize parcialmente uma configuração de chave externa. Campos omitidos permanecem inalterados.

Excluir chave externa

$ ant beta:organization:external-keys delete

DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa

$ ant beta:organization:external-keys validate

POST/v1/organizations/external_keys/{external_key_id}/validate

Valide uma configuração de chave externa em relação ao KMS do cliente.

Models

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 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: 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{ type: "azure", key_name, tenant_id, 2 more }

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.

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.

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

beta_external_key_attached_attachment: object{ type: "attached" }

type: "attached"

beta_external_key_unattached_attachment: object{ type: "unattached" }

type: "unattached"

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

type: "gcp"

key_name: string

Full resource name of the Cloud KMS key.