Claude Platform Docs

Externen Key validieren

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

ID of the External Key.

maxLength2048
Returns
type BetaOrganizationExternalKeyValidateResponse 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 BetaOrganizationExternalKeyValidateResponseStatus

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

One of the following:
const BetaOrganizationExternalKeyValidateResponseStatusFailure BetaOrganizationExternalKeyValidateResponseStatus = "failure"
const BetaOrganizationExternalKeyValidateResponseStatusSuccess BetaOrganizationExternalKeyValidateResponseStatus = "success"
Externen Key validieren
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.Beta.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"
}