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

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")
외부 키 검증
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"
}