Claude Platform Docs

Valider une clé externe

ExternalKeyValidateResponse beta().organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

Validez une configuration de clé externe auprès du KMS du client.

Anthropic effectue un aller-retour de chiffrement/déchiffrement avec la clé KMS configurée et attend le résultat jusqu'à 30 secondes. Le statut de la réponse est success si l'aller-retour a réussi, ou failure avec un message d'erreur s'il a échoué ou expiré.

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")
Valider une clé externe
package com.anthropic.example;

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

public final class Main {
    private Main() {}

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

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