ユーザーの非主要メールアドレスを削除

DELETE /v1/users/{user_id}/emails/{email_id} · 権限 users:write

ユーザーの非主要メールアドレスを 1 件削除します。主要なメールアドレスは削除できません。削除する前に、別の確認済みアドレスを主要に設定してください。環境でメールアドレスが必須の間は、ユーザーの最後の確認済みアドレスを削除できません。削除はすべて、API キーを実行者として user.email_removed で管理監査ログに記録されます。同じ行をもう一度削除すると、その行はすでに存在しないため 404 が返されます。効果は冪等ですが、ステータスコードは冪等ではありません。

リクエスト

パラメーター 場所 必須 説明
user_id path はい ユーザー ID。接頭辞は usr_。
email_id path はい メールアドレス行の ID（内部 UUID、小文字、ハイフン区切り）。GET /v1/users/{user_id}/emails が返す値です。

このリクエストにはボディがありません。

レスポンス

204 No Content。

エラー

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

HTTP code 発生条件
409 primary_identifier_required そのアドレスが主要メールアドレスである。
409 last_verified_channel 環境でメールアドレスが必須で、これが最後の確認済みアドレスである。
404 not_found この環境にユーザーまたはメールアドレス行が存在しない、そのメールアドレスがこのユーザーに属さない、または ID の形式が不正。
401 unauthenticated API キーが存在しない、無効、または取り消されている。
403 insufficient_permissions キーに users:write 権限がない。
429 rate_limited レート制限を超えた。Retry-After に従ってください。
503 service_unavailable 依存サービスが一時的に利用できない。後で再試行してください。

例

curl -X DELETE https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p/emails/0191f0a0-3333-7444-8555-666666666666 \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

個人データ

このエンドポイントは個人データを扱います：エンドユーザーのプロフィール。KeenAuth APIs の個人データでは、保存される内容、保存期間、削除方法について説明しています。どのフィールドにも、特別な種類の個人データ（健康、生体データ、宗教、政治的意見、性的指向）を送信しないでください。