Claude Platform Docs

Validasi Kunci Eksternal

client.Organization.ExternalKeys.Validate(ctx, externalKeyID) (*OrganizationExternalKeyValidateResponse, error)
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
externalKeyID string⁠Path parameter

ID of the External Key.

maxLength2048
Returns
type OrganizationExternalKeyValidateResponse struct { 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.

Type ExternalKeyValidation
defaultexternal_key_validation
Error string

Error message when status is failure. Null otherwise.

Status OrganizationExternalKeyValidateResponseStatus

success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

One of the following:
const OrganizationExternalKeyValidateResponseStatusFailure OrganizationExternalKeyValidateResponseStatus = "failure"
const OrganizationExternalKeyValidateResponseStatusSuccess OrganizationExternalKeyValidateResponseStatus = "success"
Validasi Kunci Eksternal
package main

import (
	"context"
	"fmt"

	"github.com/anthropics/anthropic-sdk-go"
	"github.com/anthropics/anthropic-sdk-go/option"
)

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"),
	)
	response, err := client.Organization.ExternalKeys.Validate(context.TODO(), "external_key_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Error)
}
Returns Examples
Response 200
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}