驗證外部金鑰

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

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

針對客戶的 KMS 驗證外部金鑰設定。

Anthropic 會對設定的 KMS 金鑰執行一次加密/解密往返，並最多等待 30 秒取得結果。若往返成功，回應狀態為 success；若失敗或逾時，則為 failure 並附帶錯誤訊息。

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.

驗證外部金鑰

<?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"
}