Validasi Kunci Eksternal

$client->organization->externalKeys->validate(string externalKeyID): 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

externalKeyID: string⁠Path

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';

use Anthropic\Client;

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

$response = $client->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"
}