Claude Platform Docs

Validasi Kunci Eksternal

organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

Validasi konfigurasi kunci eksternal terhadap KMS pelanggan.

Anthropic melakukan roundtrip enkripsi/dekripsi terhadap kunci KMS yang dikonfigurasi dan menunggu hingga 30 detik untuk hasilnya. Status respons adalah success jika roundtrip berhasil, atau failure dengan pesan error jika gagal atau waktu habis.

Parameters
external_key_id: str⁠Path parameter

ID of the External Key.

maxLength2048
Returns
class ExternalKeyValidateResponse: type: "external_key_validation"; error; status

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

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

type: Literal["external_key_validation"]
defaultexternal_key_validation
error: Optional[str]

Error message when status is failure. Null otherwise.

status: Literal["failure", "success"]

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

One of the following:
"failure"
"success"
Validasi Kunci Eksternal
import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ.get(
        "ANTHROPIC_API_KEY"
    ),  # This is the default and can be omitted
)
response = client.organization.external_keys.validate(
    "external_key_id",
)
print(response.error)
Returns Examples
Response 200
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}