Claude Platform Docs

Validasi Kunci Eksternal

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

Validasi konfigurasi kunci eksternal terhadap KMS pelanggan.

Anthropic melakukan roundtrip enkripsi/dekripsi terhadap kunci KMS yang dikonfigurasi dan menunggu hingga 30 detik untuk hasilnya. Status respons adalah success jika roundtrip berhasil, atau failure dengan pesan error jika gagal atau waktu habis.

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")
Validasi Kunci Eksternal
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"
}