Kunci Eksternal

Buat Kunci Eksternal

ExternalKey Organization.ExternalKeys.Create(parameters, cancellationToken = default)

POST/v1/organizations/external_keys

Buat konfigurasi kunci eksternal yang dimiliki oleh organisasi pemanggil.

Daftar Kunci Eksternal

ExternalKeyListPage Organization.ExternalKeys.List(parameters, cancellationToken = default)

GET/v1/organizations/external_keys

Daftar konfigurasi kunci eksternal di organisasi pemanggil.

Dapatkan Kunci Eksternal

ExternalKey Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)

GET/v1/organizations/external_keys/{external_key_id}

Ambil satu konfigurasi kunci eksternal di organisasi pemanggil berdasarkan ID.

Perbarui Kunci Eksternal

ExternalKey Organization.ExternalKeys.Update(parameters, cancellationToken = default)

POST/v1/organizations/external_keys/{external_key_id}

Perbarui sebagian konfigurasi kunci eksternal. Field yang dihilangkan tidak diubah.

Hapus Kunci Eksternal

ExternalKeyDeleteResponse Organization.ExternalKeys.Delete(parameters, cancellationToken = default)

DELETE/v1/organizations/external_keys/{external_key_id}

Hapus konfigurasi kunci eksternal.

Validasi Kunci Eksternal

ExternalKeyValidateResponse Organization.ExternalKeys.Validate(parameters, cancellationToken = default)

POST/v1/organizations/external_keys/{external_key_id}/validate

Validasi konfigurasi kunci eksternal terhadap KMS pelanggan.

Models

class AwsExternalKeyConfig { Type = "aws"; KmsArn; Region; }

JsonElement Type = "aws"

required string KmsArn

Full ARN of the AWS KMS key. On Claude Platform on AWS, alias ARNs are rejected, and your organization's own key must be a single-Region key in your organization's AWS account.

maxLength2048

string? Region

AWS region. Derived from kms_arn if omitted.

class AzureExternalKeyConfig { Type = "azure"; KeyName; TenantID; /* 2 more */ }

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.

class AzureExternalKeyConfigParam { Type = "azure"; KeyName; TenantID; /* 2 more */ }

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.

class ExternalKey { Type = "external_key"; ID; Attachment; /* 6 more */ }

CMEK external key config belonging to the caller's organization.

Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).

class ExternalKeyAttachedAttachment { Type = "attached"; }

JsonElement Type = "attached"

class ExternalKeyUnattachedAttachment { Type = "unattached"; }

JsonElement Type = "unattached"

class GcpExternalKeyConfig { Type = "gcp"; KeyName; }

JsonElement Type = "gcp"

required string KeyName

Full resource name of the Cloud KMS key.