Claude Platform Docs

Claves externas

Crear clave externa
POST/v1/organizations/external_keys
Listar claves externas
GET/v1/organizations/external_keys
Obtener clave externa
GET/v1/organizations/external_keys/{external_key_id}
Actualizar clave externa
POST/v1/organizations/external_keys/{external_key_id}
Eliminar clave externa
DELETE/v1/organizations/external_keys/{external_key_id}
Validar clave externa
POST/v1/organizations/external_keys/{external_key_id}/validate
Models
ExternalKeyCreateResponse object{ id, attachment, created_at, 5 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).

ExternalKeyRetrieveResponse object{ id, attachment, created_at, 5 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).

ExternalKeyUpdateResponse object{ id, attachment, created_at, 5 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).

ExternalKeyListResponse object{ id, attachment, created_at, 5 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).

ExternalKeyDeleteResponse object{ id, type }
id: string

ID of the deleted External Key.

type: "external_key_deleted"
defaultexternal_key_deleted
ExternalKeyValidateResponse object{ error, status, type }

Result of a validation roundtrip against the customer's KMS.

HTTP 200 for both outcomes — the operation completed; status says whether the key works.

error: string or null

Error message when status is failure. Null otherwise.

status: "failure" or "success"

success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

One of the following:
"failure"
"success"
type: "external_key_validation"
defaultexternal_key_validation