Claude Platform Docs

外部キーを検証

$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 parameter

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);
Returns Examples
Response 200
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}