Claude Platform Docs

External Keys

Create External Key
client.Beta.Organization.ExternalKeys.New(ctx, body) (*BetaExternalKey, error)
POST/v1/organizations/external_keys
List External Keys
client.Beta.Organization.ExternalKeys.List(ctx, query) (*PageCursor[BetaExternalKey], error)
GET/v1/organizations/external_keys
Get External Key
client.Beta.Organization.ExternalKeys.Get(ctx, externalKeyID) (*BetaExternalKey, error)
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
client.Beta.Organization.ExternalKeys.Update(ctx, externalKeyID, body) (*BetaExternalKey, error)
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
client.Beta.Organization.ExternalKeys.Delete(ctx, externalKeyID) (*BetaOrganizationExternalKeyDeleteResponse, error)
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
client.Beta.Organization.ExternalKeys.Validate(ctx, externalKeyID) (*BetaOrganizationExternalKeyValidateResponse, error)
POST/v1/organizations/external_keys/{external_key_id}/validate
Models
type BetaAWSExternalKeyConfig struct{…}
KMSARN string

Full ARN of the AWS KMS key.

maxLength2048
Type AWS
Region string Optional

AWS region. Derived from kms_arn if omitted.

RoleARN string OptionalDeprecated

IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored.

type BetaAzureExternalKeyConfig struct{…}
KeyName string

Name of the key within the vault.

TenantID string

Azure AD tenant ID.

Type Azure
VaultURI string

Key Vault data-plane URI — https://{vault-name}.vault.azure.net or https://{hsm-name}.managedhsm.azure.net.

ClientID string Optional

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.

type BetaAzureExternalKeyConfigParamResp struct{…}

Azure Key Vault provider configuration.

KeyName string

Name of the key within the vault.

TenantID string

Azure AD tenant ID.

Type Azure
VaultURI string

Key Vault data-plane URI — https://{vault-name}.vault.azure.net or https://{hsm-name}.managedhsm.azure.net.

ClientID string Optional

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.

type BetaExternalKey struct{…}

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 BetaExternalKeyAttachedAttachment struct{…}
Type Attached
defaultattached
type BetaExternalKeyUnattachedAttachment struct{…}
Type Unattached
defaultunattached
type BetaGCPExternalKeyConfig struct{…}
KeyName string

Full resource name of the Cloud KMS key.

Type GCP