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