Claude Platform Docs

驗證外部金鑰

ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

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

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

Parameters
ExternalKeyValidateParams parameters
required string externalKeyID⁠Path parameter

ID of the External Key.

maxLength2048
Returns
class ExternalKeyValidateResponse { Type = "external_key_validation"; Error; Status; }

Result of a validation roundtrip against the customer's KMS.

HTTP 200 for both outcomes — the operation completed; status says whether the key works.

JsonElement Type = "external_key_validation"
required string? Error

Error message when status is failure. Null otherwise.

required Status Status

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

One of the following:
Failure("failure")
Success("success")
驗證外部金鑰
using System;
using Anthropic.Models.Beta.Organization.ExternalKeys;

ExternalKeyValidateParams parameters = new()
{
    ExternalKeyID = "external_key_id"
};

var response = await client.Beta.Organization.ExternalKeys.Validate(parameters);

Console.WriteLine(response);
Returns Examples
Response 200
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}