外部キーを検証

organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse

POST/v1/organizations/external_keys/{external_key_id}/validate

顧客のKMSに対して外部キー設定を検証します。

Anthropicは設定されたKMSキーに対して暗号化/復号のラウンドトリップを実行し、結果を最大30秒間待機します。ラウンドトリップが成功した場合、レスポンスのステータスは successになり、失敗またはタイムアウトした場合はエラーメッセージとともに failureになります。

Parameters

external_key_id: String⁠Path

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.

type: :external_key_validation

error: String

Error message when status is failure. Null otherwise.

status: :failure | :success

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

One of the following:

:failure

:success

外部キーを検証

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

response = anthropic.organization.external_keys.validate("external_key_id")

puts(response)

Response 200

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}

Returns Examples

Response 200

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}