Claude Platform Docs

外部キーを検証

$client->beta->organization->externalKeys->validate(string externalKeyID): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

外部キー設定を顧客の KMS に対して検証します。

Anthropic は設定された KMS キーに対して暗号化/復号のラウンドトリップを実行し、結果を最大 30 秒間待機します。レスポンスのステータスは、ラウンドトリップが成功した場合は success、失敗またはタイムアウトした場合はエラーメッセージ付きの failure になります。

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.

外部キーを検証
<?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);
Returns Examples
Response 200
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}