Claude Platform Docs

Externen Key validieren

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

Validiert eine externe Key-Konfiguration gegen das KMS des Kunden.

Anthropic führt einen Verschlüsselungs-/Entschlüsselungs-Roundtrip mit dem konfigurierten KMS-Key durch und wartet bis zu 30 Sekunden auf das Ergebnis. Der Antwortstatus ist success, wenn der Roundtrip erfolgreich war, oder failure mit einer Fehlermeldung, wenn er fehlgeschlagen ist oder eine Zeitüberschreitung aufgetreten ist.

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")
Externen Key validieren
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"
}