Claude Platform Docs

Validar chave externa

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

Valide uma configuração de chave externa em relação ao KMS do cliente.

A Anthropic realiza um ciclo de criptografia/descriptografia com a chave KMS configurada e aguarda até 30 segundos pelo resultado. O status da resposta é success se o ciclo for bem-sucedido, ou failure com uma mensagem de erro se falhar ou expirar.

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")
Validar chave externa
using System;
using Anthropic.Models.Organization.ExternalKeys;

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

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

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