--- title: External Keys url: https://platform.claude.com/docs/en/api/typescript/organization/external_keys --- # External Keys ## Create External Key `client.organization.externalKeys.create(body, options?): ExternalKey` **POST** `/v1/organizations/external_keys` Create an external key config owned by the caller's organization. ### Parameters - `body: ExternalKeyCreateParams` - `provider_config: AWSExternalKeyConfig | GCPExternalKeyConfig | AzureExternalKeyConfigParam` KMS provider identity and auth coordinates. - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `interface AzureExternalKeyConfigParam` 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 | 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. - `display_name?: string | null` Human-friendly display name. minLength: 1, maxLength: 255 - `geo?: "us"` Data residency geo. Only `us` is supported. ### Returns - `interface ExternalKey` 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). - `type: "external_key"` default: external_key - `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: ExternalKeyAttachedAttachment | ExternalKeyUnattachedAttachment` 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. - `interface ExternalKeyAttachedAttachment` - `type: "attached"` default: attached - `interface ExternalKeyUnattachedAttachment` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string | 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: AWSExternalKeyConfig | GCPExternalKeyConfig | AzureExternalKeyConfig` KMS provider identity and auth coordinates. - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `interface AzureExternalKeyConfig` - `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 | 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. - `updated_at: string` format: date-time ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const externalKey = await client.organization.externalKeys.create({ provider_config: { kms_arn: "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", type: "aws" } }); console.log(externalKey.id); ``` #### Response (200) ```json { "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" } ``` ## List External Keys `client.organization.externalKeys.list(query?, options?): PageCursor` **GET** `/v1/organizations/external_keys` List external key configs in the caller's organization. Results are ordered by creation time (newest first). Use the `next_page` cursor from the response to fetch subsequent pages. ### Parameters - `query: ExternalKeyListParams` - `limit?: number` (query parameter) Number of results per page. minimum: 1, maximum: 100 - `page?: string | null` (query parameter) Opaque cursor from a previous response's `next_page`. ### Returns - `interface ExternalKey` 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). - `type: "external_key"` default: external_key - `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: ExternalKeyAttachedAttachment | ExternalKeyUnattachedAttachment` 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. - `interface ExternalKeyAttachedAttachment` - `type: "attached"` default: attached - `interface ExternalKeyUnattachedAttachment` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string | 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: AWSExternalKeyConfig | GCPExternalKeyConfig | AzureExternalKeyConfig` KMS provider identity and auth coordinates. - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `interface AzureExternalKeyConfig` - `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 | 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. - `updated_at: string` format: date-time ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const externalKey of client.organization.externalKeys.list()) { console.log(externalKey.id); } ``` #### Response (200) ```json { "data": [ { "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" } ], "next_page": "next_page" } ``` ## Get External Key `client.organization.externalKeys.retrieve(externalKeyID, options?): ExternalKey` **GET** `/v1/organizations/external_keys/{external_key_id}` Retrieve a single external key config in the caller's organization by ID. ### Parameters - `externalKeyID: string` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `interface ExternalKey` 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). - `type: "external_key"` default: external_key - `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: ExternalKeyAttachedAttachment | ExternalKeyUnattachedAttachment` 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. - `interface ExternalKeyAttachedAttachment` - `type: "attached"` default: attached - `interface ExternalKeyUnattachedAttachment` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string | 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: AWSExternalKeyConfig | GCPExternalKeyConfig | AzureExternalKeyConfig` KMS provider identity and auth coordinates. - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `interface AzureExternalKeyConfig` - `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 | 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. - `updated_at: string` format: date-time ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const externalKey = await client.organization.externalKeys.retrieve("external_key_id"); console.log(externalKey.id); ``` #### Response (200) ```json { "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" } ``` ## Update External Key `client.organization.externalKeys.update(externalKeyID, body, options?): ExternalKey` **POST** `/v1/organizations/external_keys/{external_key_id}` Partially update an external key config. Omitted fields are left unchanged. `display_name` is always editable. `geo` and `provider_config` cannot be changed once any workspace references this config, because previously encrypted data requires the original key identity to decrypt. ### Parameters - `externalKeyID: string` (path parameter) ID of the External Key. maxLength: 2048 - `body: ExternalKeyUpdateParams` - `display_name?: string | null` Human-friendly display name. minLength: 1, maxLength: 255 - `geo?: "us" | null` Data residency geo. Only `us` is supported. - `provider_config?: AWSExternalKeyConfig | GCPExternalKeyConfig | AzureExternalKeyConfigParam | null` KMS provider identity and auth coordinates. - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `interface AzureExternalKeyConfigParam` 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 | 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 - `interface ExternalKey` 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). - `type: "external_key"` default: external_key - `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: ExternalKeyAttachedAttachment | ExternalKeyUnattachedAttachment` 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. - `interface ExternalKeyAttachedAttachment` - `type: "attached"` default: attached - `interface ExternalKeyUnattachedAttachment` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string | 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: AWSExternalKeyConfig | GCPExternalKeyConfig | AzureExternalKeyConfig` KMS provider identity and auth coordinates. - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `interface AzureExternalKeyConfig` - `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 | 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. - `updated_at: string` format: date-time ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const externalKey = await client.organization.externalKeys.update("external_key_id"); console.log(externalKey.id); ``` #### Response (200) ```json { "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" } ``` ## Delete External Key `client.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse` **DELETE** `/v1/organizations/external_keys/{external_key_id}` Delete an external key config. The request is rejected if any workspace still references this config. ### Parameters - `externalKeyID: string` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `interface ExternalKeyDeleteResponse` - `type: "external_key_deleted"` default: external_key_deleted - `id: string` ID of the deleted External Key. ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const externalKey = await client.organization.externalKeys.delete("external_key_id"); console.log(externalKey.id); ``` #### Response (200) ```json { "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", "type": "external_key_deleted" } ``` ## Validate External Key `client.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse` **POST** `/v1/organizations/external_keys/{external_key_id}/validate` Validate an external key config against the customer's KMS. Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is `success` if the roundtrip succeeded, or `failure` with an error message if it failed or timed out. ### Parameters - `externalKeyID: string` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `interface ExternalKeyValidateResponse` Result of a validation roundtrip against the customer's KMS. HTTP 200 for both outcomes — the operation completed; `status` says whether the key works. - `type: "external_key_validation"` default: external_key_validation - `error: string | null` Error message when status is `failure`. Null otherwise. - `status: "failure" | "success"` `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. - `"failure"` - `"success"` ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const response = await client.organization.externalKeys.validate("external_key_id"); console.log(response.error); ``` #### Response (200) ```json { "error": "error", "status": "failure", "type": "external_key_validation" } ``` ## Domain types ### AWS External Key Config - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. ### Azure External Key Config - `interface AzureExternalKeyConfig` - `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 | 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. ### Azure External Key Config Param - `interface AzureExternalKeyConfigParam` 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 | 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. ### External Key - `interface ExternalKey` 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). - `type: "external_key"` default: external_key - `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: ExternalKeyAttachedAttachment | ExternalKeyUnattachedAttachment` 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. - `interface ExternalKeyAttachedAttachment` - `type: "attached"` default: attached - `interface ExternalKeyUnattachedAttachment` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string | 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: AWSExternalKeyConfig | GCPExternalKeyConfig | AzureExternalKeyConfig` KMS provider identity and auth coordinates. - `interface AWSExternalKeyConfig` - `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. maxLength: 2048 - `region?: string | null` AWS region. Derived from `kms_arn` if omitted. - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `interface AzureExternalKeyConfig` - `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 | 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. - `updated_at: string` format: date-time ### External Key Attached Attachment - `interface ExternalKeyAttachedAttachment` - `type: "attached"` default: attached ### External Key Unattached Attachment - `interface ExternalKeyUnattachedAttachment` - `type: "unattached"` default: unattached ### GCP External Key Config - `interface GCPExternalKeyConfig` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. ### External Key Delete Response - `interface ExternalKeyDeleteResponse` - `type: "external_key_deleted"` default: external_key_deleted - `id: string` ID of the deleted External Key. ### External Key Validate Response - `interface ExternalKeyValidateResponse` Result of a validation roundtrip against the customer's KMS. HTTP 200 for both outcomes — the operation completed; `status` says whether the key works. - `type: "external_key_validation"` default: external_key_validation - `error: string | null` Error message when status is `failure`. Null otherwise. - `status: "failure" | "success"` `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. - `"failure"` - `"success"`