--- title: External Keys url: https://platform.claude.com/docs/en/api/csharp/organization/external_keys --- # External Keys ## Create External Key `ExternalKey Organization.ExternalKeys.Create(parameters, cancellationToken = default)` **POST** `/v1/organizations/external_keys` Create an external key config owned by the caller's organization. ### Parameters - `ExternalKeyCreateParams parameters` - `required ProviderConfig providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfigParam` Azure Key Vault provider configuration. - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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. - `string? displayName` Human-friendly display name. minLength: 1, maxLength: 255 - `Geo 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). - `JsonElement Type = "external_key"` - `required 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. - `required 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` - `JsonElement Type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonElement Type = "unattached"` - `required DateTimeOffset CreatedAt` format: date-time - `required string? DisplayName` Human-friendly display name. Null if none was set. - `required string Geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `required ProviderConfig ProviderConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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. - `required DateTimeOffset UpdatedAt` format: date-time ### Example ```csharp using System; using Anthropic.Models.Organization.ExternalKeys; ExternalKeyCreateParams parameters = new() { ProviderConfig = new AwsExternalKeyConfig() { KmsArn = "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", Region = "us-east-1", }, }; var externalKey = await client.Organization.ExternalKeys.Create(parameters); Console.WriteLine(externalKey); ``` #### 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(parameters, cancellationToken = default)` **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 parameters` - `long limit` (query parameter) Number of results per page. minimum: 1, maximum: 100 - `string? 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). - `JsonElement Type = "external_key"` - `required 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. - `required 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` - `JsonElement Type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonElement Type = "unattached"` - `required DateTimeOffset CreatedAt` format: date-time - `required string? DisplayName` Human-friendly display name. Null if none was set. - `required string Geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `required ProviderConfig ProviderConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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. - `required DateTimeOffset UpdatedAt` format: date-time ### Example ```csharp using System; using Anthropic.Models.Organization.ExternalKeys; ExternalKeyListParams parameters = new(); var page = await client.Organization.ExternalKeys.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` #### 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(parameters, cancellationToken = default)` **GET** `/v1/organizations/external_keys/{external_key_id}` Retrieve a single external key config in the caller's organization by ID. ### Parameters - `ExternalKeyRetrieveParams parameters` - `required string 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). - `JsonElement Type = "external_key"` - `required 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. - `required 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` - `JsonElement Type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonElement Type = "unattached"` - `required DateTimeOffset CreatedAt` format: date-time - `required string? DisplayName` Human-friendly display name. Null if none was set. - `required string Geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `required ProviderConfig ProviderConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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. - `required DateTimeOffset UpdatedAt` format: date-time ### Example ```csharp using System; using Anthropic.Models.Organization.ExternalKeys; ExternalKeyRetrieveParams parameters = new() { ExternalKeyID = "external_key_id" }; var externalKey = await client.Organization.ExternalKeys.Retrieve(parameters); Console.WriteLine(externalKey); ``` #### 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(parameters, cancellationToken = default)` **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 parameters` - `required string externalKeyID` (path parameter) ID of the External Key. maxLength: 2048 - `string? displayName` Human-friendly display name. minLength: 1, maxLength: 255 - `Geo? geo` Data residency geo. Only `us` is supported. - `Us("us")` - `ProviderConfig? providerConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfigParam` Azure Key Vault provider configuration. - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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). - `JsonElement Type = "external_key"` - `required 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. - `required 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` - `JsonElement Type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonElement Type = "unattached"` - `required DateTimeOffset CreatedAt` format: date-time - `required string? DisplayName` Human-friendly display name. Null if none was set. - `required string Geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `required ProviderConfig ProviderConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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. - `required DateTimeOffset UpdatedAt` format: date-time ### Example ```csharp using System; using Anthropic.Models.Organization.ExternalKeys; ExternalKeyUpdateParams parameters = new() { ExternalKeyID = "external_key_id" }; var externalKey = await client.Organization.ExternalKeys.Update(parameters); Console.WriteLine(externalKey); ``` #### 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(parameters, cancellationToken = default)` **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 parameters` - `required string externalKeyID` (path parameter) ID of the External Key. maxLength: 2048 ### Returns - `class ExternalKeyDeleteResponse` - `JsonElement Type = "external_key_deleted"` - `required string ID` ID of the deleted External Key. ### Example ```csharp using System; using Anthropic.Models.Organization.ExternalKeys; ExternalKeyDeleteParams parameters = new() { ExternalKeyID = "external_key_id" }; var externalKey = await client.Organization.ExternalKeys.Delete(parameters); Console.WriteLine(externalKey); ``` #### Response (200) ```json { "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", "type": "external_key_deleted" } ``` ## Validate External Key `ExternalKeyValidateResponse Organization.ExternalKeys.Validate(parameters, cancellationToken = default)` **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 parameters` - `required string 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. - `JsonElement Type = "external_key_validation"` - `required string? Error` Error message when status is `failure`. Null otherwise. - `required Status Status` `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. - `Failure("failure")` - `Success("success")` ### Example ```csharp using System; using Anthropic.Models.Organization.ExternalKeys; ExternalKeyValidateParams parameters = new() { ExternalKeyID = "external_key_id" }; var response = await client.Organization.ExternalKeys.Validate(parameters); Console.WriteLine(response); ``` #### Response (200) ```json { "error": "error", "status": "failure", "type": "external_key_validation" } ``` ## Domain types ### AWS External Key Config - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. ### Azure External Key Config - `class AzureExternalKeyConfig` - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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. - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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). - `JsonElement Type = "external_key"` - `required 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. - `required 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` - `JsonElement Type = "attached"` - `class ExternalKeyUnattachedAttachment` - `JsonElement Type = "unattached"` - `required DateTimeOffset CreatedAt` format: date-time - `required string? DisplayName` Human-friendly display name. Null if none was set. - `required string Geo` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `required ProviderConfig ProviderConfig` KMS provider identity and auth coordinates. - `class AwsExternalKeyConfig` - `JsonElement Type = "aws"` - `required 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 - `string? Region` AWS region. Derived from `kms_arn` if omitted. - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key. - `class AzureExternalKeyConfig` - `JsonElement Type = "azure"` - `required string KeyName` Name of the key within the vault. - `required string TenantID` Azure AD tenant ID. - `required string VaultUri` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `string? 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. - `required DateTimeOffset UpdatedAt` format: date-time ### External Key Attached Attachment - `class ExternalKeyAttachedAttachment` - `JsonElement Type = "attached"` ### External Key Unattached Attachment - `class ExternalKeyUnattachedAttachment` - `JsonElement Type = "unattached"` ### GCP External Key Config - `class GcpExternalKeyConfig` - `JsonElement Type = "gcp"` - `required string KeyName` Full resource name of the Cloud KMS key.