ユーザーから連携済みIDのリンクを解除

DELETE /v1/users/{user_id}/identities/{identity_id} · 権限 users:write

ユーザーの連携済みIDを 1 件削除します（パスワード、ソーシャル、SAML、OIDC、レガシー）。ユーザーが所属する組織が、そのIDの接続を通じてシングルサインオンを強制している場合でも削除は実行されます。ユーザーはアカウントポータルからそのようなIDを削除できません（409 sso_enforced_by_organization）。このため、顧客はこのエンドポイントを使用して削除します。ユーザーの最後の第一要素認証方式は削除できません（409 last_login_method）。ユーザーには確認済みのすべてのメールアドレスに通知が送られ、操作はAPI キーを実行者として管理監査ログに記録されます。

リクエスト

パラメータ 指定場所 必須 説明
user_id path はい ユーザー ID。接頭辞は usr_ です。
identity_id path はい ID の ID。接頭辞は idn_ です（GET /v1/users/{user_id}/identities が返す値）。

リクエストにはボディを指定しません。

レスポンス

204 No Content。

エラー

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

HTTP code 発生条件
404 not_found この環境にユーザーが存在しない、そのIDがこのユーザーに属さない、または不明である、あるいはいずれかの ID の形式が不正です。
409 last_login_method このIDはユーザーの最後の第一要素認証方式です。先に別の方式を追加してください。
401 unauthenticated API キーが未指定、無効、または取り消されています。
403 insufficient_permissions API キーに users:write 権限がありません。
429 rate_limited レート制限を超えました。Retry-After に従ってください。
503 service_unavailable 依存先サービスが一時的に利用できません。後で再試行してください。

例

curl -X DELETE https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p/identities/idn_0a1b2c3d4e5f6g7h8j9k0m1n2r \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

個人データ

このエンドポイントは個人データ（連携済みID）を扱います。KeenAuth API の個人データでは、保存される内容、保存期間、削除方法について説明しています。いずれのフィールドにも、特別なカテゴリーの個人データ（健康、生体情報、宗教、政治的意見、性的指向）を送信しないでください。