プライマリメールアドレスに検証メールを送信

POST /v1/users/{user_id}:send-verification-email · 権限 user-credentials:write

ユーザーのプライマリメールアドレスに検証メールを送信します。レスポンスには検証リクエストの有効期限が含まれます。コードやリンクは返されません。特定のメール行を対象にする場合は、メールアドレスに検証メールを送信を使用してください。省略可能なボディはメールの言語のみを選択します。

リクエスト

パラメータ 位置 必須 説明
user_id path はい ユーザー ID。usr_ で始まります。

省略可能なボディ:

フィールド 型 必須 説明
locale string いいえ メールの BCP 47 言語タグ(例: tr や pt-BR)。省略時はユーザーまたは環境の言語が使われます。

レスポンス

200 OK。expires_at は検証リクエストの有効期限です。

{
  "expires_at": "2026-01-16T09:30:00Z"
}

エラー

すべてのエラーは、安定した code を含む application/problem+json ボディです。

HTTP code 発生条件
400 malformed_request, unknown_field ボディが有効な JSON ではないか、未知のフィールドが含まれています。
409 conflict プライマリメールアドレスは検証済みか、ユーザーにプライマリメールアドレスがありません。
415 unsupported_media_type Content-Type: application/json を指定せずにボディを送信しました。
422 validation_failed locale が有効な BCP 47 言語タグではないか、フィールドの型が誤っています。
404 not_found この環境にユーザーが存在しないか、ID の形式が誤っています。
401 unauthenticated API キーが未指定、無効、または取り消されています。
403 insufficient_permissions このキーには user-credentials:write 権限がありません。
429 rate_limited API のレート制限、またはユーザーごとのメール送信制限を超えました。Retry-After に従ってください。
503 service_unavailable 依存先が一時的に利用できません。しばらくしてから再試行してください。

例

curl -X POST https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p:send-verification-email \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"locale": "en"}'