--- title: External Keys url: https://platform.claude.com/docs/en/api/java/organization/external_keys --- # External Keys ## Create External Key `ExternalKey organization().externalKeys().create(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/external_keys` Create an external key config owned by the caller's organization. ### Parameters - `ExternalKeyCreateParams params` - `ProviderConfig providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfigParam` Azure Key Vault provider configuration. - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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. - `Optional displayName` Human-friendly display name. minLength: 1, maxLength: 255 - `Optional geo` Data residency geo. Only `us` is supported. - `US("us")` ### Returns - `class 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). - `JsonValue type = "external_key"` - `String id` 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 attachment` 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 ExternalKeyAttachedAttachment` - `JsonValue type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonValue type = "unattached"` - `LocalDateTime createdAt` format: date-time - `Optional displayName` Human-friendly display name. Null if none was set. - `String geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `ProviderConfig providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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. - `LocalDateTime updatedAt` format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.externalkeys.ExternalKey; import com.anthropic.models.organization.externalkeys.ExternalKeyCreateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ExternalKeyCreateParams params = ExternalKeyCreateParams.builder() .awsProviderConfig("arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222") .build(); ExternalKey externalKey = client.organization().externalKeys().create(params); } } ``` #### 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 `ExternalKeyListPage organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())` **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 - `ExternalKeyListParams params` - `Optional limit` (query parameter) Number of results per page. minimum: 1, maximum: 100 - `Optional page` (query parameter) Opaque cursor from a previous response's `next_page`. ### Returns - `class 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). - `JsonValue type = "external_key"` - `String id` 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 attachment` 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 ExternalKeyAttachedAttachment` - `JsonValue type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonValue type = "unattached"` - `LocalDateTime createdAt` format: date-time - `Optional displayName` Human-friendly display name. Null if none was set. - `String geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `ProviderConfig providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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. - `LocalDateTime updatedAt` format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.externalkeys.ExternalKeyListPage; import com.anthropic.models.organization.externalkeys.ExternalKeyListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ExternalKeyListPage page = client.organization().externalKeys().list(); } } ``` #### 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 `ExternalKey organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/external_keys/{external_key_id}` Retrieve a single external key config in the caller's organization by ID. ### Parameters - `ExternalKeyRetrieveParams params` - `Optional externalKeyId` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `class 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). - `JsonValue type = "external_key"` - `String id` 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 attachment` 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 ExternalKeyAttachedAttachment` - `JsonValue type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonValue type = "unattached"` - `LocalDateTime createdAt` format: date-time - `Optional displayName` Human-friendly display name. Null if none was set. - `String geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `ProviderConfig providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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. - `LocalDateTime updatedAt` format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.externalkeys.ExternalKey; import com.anthropic.models.organization.externalkeys.ExternalKeyRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ExternalKey externalKey = client.organization().externalKeys().retrieve("external_key_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 `ExternalKey organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())` **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 - `ExternalKeyUpdateParams params` - `Optional externalKeyId` (path parameter) ID of the External Key. maxLength: 2048 - `Optional displayName` Human-friendly display name. minLength: 1, maxLength: 255 - `Optional geo` Data residency geo. Only `us` is supported. - `US("us")` - `Optional providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfigParam` Azure Key Vault provider configuration. - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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 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). - `JsonValue type = "external_key"` - `String id` 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 attachment` 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 ExternalKeyAttachedAttachment` - `JsonValue type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonValue type = "unattached"` - `LocalDateTime createdAt` format: date-time - `Optional displayName` Human-friendly display name. Null if none was set. - `String geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `ProviderConfig providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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. - `LocalDateTime updatedAt` format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.externalkeys.ExternalKey; import com.anthropic.models.organization.externalkeys.ExternalKeyUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ExternalKey externalKey = client.organization().externalKeys().update("external_key_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 `ExternalKeyDeleteResponse organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())` **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 - `ExternalKeyDeleteParams params` - `Optional externalKeyId` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `class ExternalKeyDeleteResponse` - `JsonValue type = "external_key_deleted"` - `String id` ID of the deleted External Key. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.externalkeys.ExternalKeyDeleteParams; import com.anthropic.models.organization.externalkeys.ExternalKeyDeleteResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ExternalKeyDeleteResponse externalKey = client.organization().externalKeys().delete("external_key_id"); } } ``` #### Response (200) ```json { "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", "type": "external_key_deleted" } ``` ## Validate External Key `ExternalKeyValidateResponse organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())` **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 - `ExternalKeyValidateParams params` - `Optional externalKeyId` (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. - `JsonValue type = "external_key_validation"` - `Optional error` Error message when status is `failure`. Null otherwise. - `Status status` `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. - `FAILURE("failure")` - `SUCCESS("success")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.externalkeys.ExternalKeyValidateParams; import com.anthropic.models.organization.externalkeys.ExternalKeyValidateResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ExternalKeyValidateResponse response = client.organization().externalKeys().validate("external_key_id"); } } ``` #### Response (200) ```json { "error": "error", "status": "failure", "type": "external_key_validation" } ``` ## Domain types ### AWS External Key Config - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. ### Azure External Key Config - `class AzureExternalKeyConfig` - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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 - `class AzureExternalKeyConfigParam` Azure Key Vault provider configuration. - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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 - `class 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). - `JsonValue type = "external_key"` - `String id` 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 attachment` 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 ExternalKeyAttachedAttachment` - `JsonValue type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonValue type = "unattached"` - `LocalDateTime createdAt` format: date-time - `Optional displayName` Human-friendly display name. Null if none was set. - `String geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `ProviderConfig providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonValue type = "aws"` - `String kmsArn` 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 - `Optional region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonValue type = "azure"` - `String keyName` Name of the key within the vault. - `String tenantId` Azure AD tenant ID. - `String vaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `Optional clientId` 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. - `LocalDateTime updatedAt` format: date-time ### External Key Attached Attachment - `class ExternalKeyAttachedAttachment` - `JsonValue type = "attached"` ### External Key Unattached Attachment - `class ExternalKeyUnattachedAttachment` - `JsonValue type = "unattached"` ### GCP External Key Config - `class GcpExternalKeyConfig` - `JsonValue type = "gcp"` - `String keyName` Full resource name of the Cloud KMS key.