Claude Platform Docs

Externen Key validieren

ExternalKeyValidateResponse organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())
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 params
Optional<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.

JsonValue type = "external_key_validation"
Optional<String> error

Error message when status is failure. Null otherwise.

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
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.externalkeys.ExternalKeyValidateParams;
import com.anthropic.models.organization.externalkeys.ExternalKeyValidateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        ExternalKeyValidateResponse response = client.organization().externalKeys().validate("external_key_id");
    }
}
Returns Examples
Response 200
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}