--- title: External Keys url: https://platform.claude.com/docs/en/api/ruby/beta/organization/external_keys --- # External Keys ## Create External Key `beta.organization.external_keys.create(**kwargs) -> BetaExternalKey` **POST** `/v1/organizations/external_keys` Create an external key config owned by the caller's organization. ### Parameters - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfigParam` KMS provider identity and auth coordinates. - `class BetaAWSExternalKeyConfig` - `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` 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: String` Full resource name of the Cloud KMS key. - `class BetaAzureExternalKeyConfigParam` 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. - `display_name: String` Human-friendly display name. minLength: 1, maxLength: 255 - `geo: :us` Data residency geo. Only `us` is supported. ### Returns - `class BetaExternalKey` 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` - `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: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` 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. - `class BetaExternalKeyAttachedAttachment` - `type: :attached` - `class BetaExternalKeyUnattachedAttachment` - `type: :unattached` - `created_at: Time` format: date-time - `display_name: String` 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: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `class BetaAWSExternalKeyConfig` - `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` 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: String` Full resource name of the Cloud KMS key. - `class BetaAzureExternalKeyConfig` - `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. - `updated_at: Time` format: date-time ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") beta_external_key = anthropic.beta.organization.external_keys.create( provider_config: {kms_arn: "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", type: :aws} ) puts(beta_external_key) ``` #### 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 `beta.organization.external_keys.list(**kwargs) -> 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 - `limit: Integer` (query parameter) Number of results per page. minimum: 1, maximum: 100 - `page: String` (query parameter) Opaque cursor from a previous response's `next_page`. ### Returns - `class BetaExternalKey` 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` - `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: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` 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. - `class BetaExternalKeyAttachedAttachment` - `type: :attached` - `class BetaExternalKeyUnattachedAttachment` - `type: :unattached` - `created_at: Time` format: date-time - `display_name: String` 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: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `class BetaAWSExternalKeyConfig` - `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` 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: String` Full resource name of the Cloud KMS key. - `class BetaAzureExternalKeyConfig` - `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. - `updated_at: Time` format: date-time ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") page = anthropic.beta.organization.external_keys.list puts(page) ``` #### 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 `beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKey` **GET** `/v1/organizations/external_keys/{external_key_id}` Retrieve a single external key config in the caller's organization by ID. ### Parameters - `external_key_id: String` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `class BetaExternalKey` 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` - `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: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` 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. - `class BetaExternalKeyAttachedAttachment` - `type: :attached` - `class BetaExternalKeyUnattachedAttachment` - `type: :unattached` - `created_at: Time` format: date-time - `display_name: String` 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: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `class BetaAWSExternalKeyConfig` - `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` 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: String` Full resource name of the Cloud KMS key. - `class BetaAzureExternalKeyConfig` - `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. - `updated_at: Time` format: date-time ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") beta_external_key = anthropic.beta.organization.external_keys.retrieve("external_key_id") puts(beta_external_key) ``` #### 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 `beta.organization.external_keys.update(external_key_id, **kwargs) -> BetaExternalKey` **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 - `external_key_id: String` (path parameter) ID of the External Key. maxLength: 2048 - `display_name: String` Human-friendly display name. minLength: 1, maxLength: 255 - `geo: :us` Data residency geo. Only `us` is supported. - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfigParam` KMS provider identity and auth coordinates. - `class BetaAWSExternalKeyConfig` - `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` 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: String` Full resource name of the Cloud KMS key. - `class BetaAzureExternalKeyConfigParam` 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` 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` - `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: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` 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. - `class BetaExternalKeyAttachedAttachment` - `type: :attached` - `class BetaExternalKeyUnattachedAttachment` - `type: :unattached` - `created_at: Time` format: date-time - `display_name: String` 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: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `class BetaAWSExternalKeyConfig` - `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` 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: String` Full resource name of the Cloud KMS key. - `class BetaAzureExternalKeyConfig` - `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. - `updated_at: Time` format: date-time ### Example ```ruby 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) ``` #### 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 `beta.organization.external_keys.delete(external_key_id) -> 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 - `external_key_id: String` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `class ExternalKeyDeleteResponse` - `type: :external_key_deleted` - `id: String` ID of the deleted External Key. ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") external_key = anthropic.beta.organization.external_keys.delete("external_key_id") puts(external_key) ``` #### Response (200) ```json { "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", "type": "external_key_deleted" } ``` ## Validate External Key `beta.organization.external_keys.validate(external_key_id) -> 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 - `external_key_id: String` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `class 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` - `error: String` 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 ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") response = anthropic.beta.organization.external_keys.validate("external_key_id") puts(response) ``` #### Response (200) ```json { "error": "error", "status": "failure", "type": "external_key_validation" } ``` ## Domain types ### Beta AWS External Key Config - `class BetaAWSExternalKeyConfig` - `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` 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. ### Beta Azure External Key Config - `class BetaAzureExternalKeyConfig` - `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. ### Beta Azure External Key Config Param - `class BetaAzureExternalKeyConfigParam` 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. ### Beta External Key - `class BetaExternalKey` 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` - `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: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` 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. - `class BetaExternalKeyAttachedAttachment` - `type: :attached` - `class BetaExternalKeyUnattachedAttachment` - `type: :unattached` - `created_at: Time` format: date-time - `display_name: String` 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: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `class BetaAWSExternalKeyConfig` - `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` 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: String` Full resource name of the Cloud KMS key. - `class BetaAzureExternalKeyConfig` - `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. - `updated_at: Time` format: date-time ### Beta External Key Attached Attachment - `class BetaExternalKeyAttachedAttachment` - `type: :attached` ### Beta External Key Unattached Attachment - `class BetaExternalKeyUnattachedAttachment` - `type: :unattached` ### Beta GCP External Key Config - `class BetaGCPExternalKeyConfig` - `type: :gcp` - `key_name: String` Full resource name of the Cloud KMS key. ### External Key Delete Response - `class ExternalKeyDeleteResponse` - `type: :external_key_deleted` - `id: String` ID of the deleted External Key. ### External Key Validate Response - `class 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` - `error: String` 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`