Validasi Kunci Eksternal

$client->beta->organization->externalKeys->validate(string externalKeyID): ExternalKeyValidateResponse

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

Validasi konfigurasi kunci eksternal terhadap KMS pelanggan.

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

Parameters

externalKeyID: string

ID of the External Key.

Returns

class ExternalKeyValidateResponse { $type = 'external_key_validation'; $error; $status; }

"external_key_validation" type

?string error

Error message when status is failure. Null otherwise.

Status status

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

Validasi Kunci Eksternal

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'my-anthropic-api-key');

$response = $client->beta->organization->externalKeys->validate(
  'external_key_id'
);

var_dump($response);

Response 200

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}

Returns Examples

Response 200

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}