Claude Platform Docs

Create External Key

$ ant organization:external-keys create
POST/v1/organizations/external_keys

Create an external key config owned by the caller's organization.

Parameters

KMS provider identity and auth coordinates.

One of the following:
aws_external_key_config: object{ type: "aws", kms_arn, region }
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.

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

Full resource name of the Cloud KMS key.

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.

--display-name: optional string

Human-friendly display name.

minLength1
maxLength255
--geo: optional "us"

Data residency geo. Only us is supported.

--user-profile-id: optional string

ID of a user profile to bind the key to. A user profile represents one of your customers: bind a customer's key to that customer's user profile. A key bound to a user profile can only be attached to a Workspace that has the same user profile, and the binding cannot be changed later. Omit this field only for your organization's own key, never a customer's. A key created without a user profile ID can't be attached to a Workspace that has a user profile, and you can't add one to the key later.

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

Errors

Any method can also return the general HTTP errors.

Each code below is the value of error.details.error_code in the response body.

error code user_profile_not_foundHTTP status 400

The request depends on a user profile that does not exist in the organization or is no longer active. The request either names this user profile by ID, or names a resource, such as an External Key, that is bound to it.

error code sandbox_egress_restrictedHTTP status 403

The request came from a Claude sandbox with restricted network access, which is not allowed to make this change. Send it from outside the sandbox, or from a sandbox with unrestricted network access.

Create External Key
ant organization:external-keys create \
  --provider-config '{kms_arn: arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222, type: aws}'
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"
}