エンドポイント
GET /oidc/logout
このエンドポイントを使用して、ユーザーをログアウトできます。ログアウト後にユーザーを特定の URL に遷移させたい場合は、その URL を post_logout_redirect_uri パラメーターに設定します。この URL は、該当する Allowed Logout URLs の一覧に含まれている必要があります。
id_token_hint パラメーターが含まれている場合:
client_id パラメーターが含まれている場合、サーバーは id_token_hint の aud クレーム内の URL を使用して、client_id で指定されたアプリケーションに設定されている Allowed Logout URLs のうち、どれを使用するかを選択します。
client_id パラメーターが含まれていない場合、サーバーは id_token_hint の aud クレーム内の URL を使用して、テナントレベルに設定されている Allowed Logout URLs のうち、どれを使用するかを選択します。
id_token_hint パラメーターが含まれていない場合:
client_id パラメーターが含まれている場合、post_logout_redirect_uri の URL は、アプリケーションレベルで設定された Allowed Logout URLs の一覧に含まれている必要があります。
client_id パラメーターが含まれていない場合、post_logout_redirect_uri の URL は、テナントレベルで設定された Allowed Logout URLs の一覧に含まれている必要があります。
client_id パラメーターが含まれており、post_logout_redirect_uri の URL が設定されていない場合、サーバーはユーザーを Auth0 Dashboard で設定された最初の Allowed Logout URLs にリダイレクトします。
詳しくは、OIDC エンドポイント を使用して Auth0 からユーザーをログアウトするを参照してください。
- ユーザーをソーシャル ID プロバイダーからログアウトさせることは一般的ではないため、ソーシャル ID プロバイダーで
federated クエリ文字列パラメーターを使用する前に、ユーザーエクスペリエンスを十分に考慮してください。
id_token_hint と logout_hint の両方を指定する場合、logout_hint の値は id_token_hint の sid クレームと一致している必要があります。
id_token_hint と client_id の両方を指定する場合、client_id の値は id_token_hint の aud クレームと一致している必要があります。
id_token_hint が指定されていない場合、ユーザーのセッション ID と一致する logout_hint が指定されていない限り、ユーザーに同意を求めるプロンプトが表示されます。
- このリクエストでは
POST HTTP メソッドもサポートされています。POST を使用する場合、リクエストパラメーターはクエリ文字列ではなく、フォームパラメーターとしてリクエストボディで指定する必要があります。federated パラメーターには true または false を指定する必要があります。
- これは OIDC RP-Initiated Logout 仕様 に準拠しています。
詳しくはこちら
クエリパラメータ
[推奨] ユーザーに以前発行された ID トークンです。どのユーザーをログアウトするかを示すために使用されます。
どのユーザーをログアウトするかを示すための、任意の sid (セッション ID) 値です。id_token_hint が利用できない場合に指定してください。
ログアウト後にユーザーをリダイレクトするための URL です。
ユーザーを ID プロバイダーからログアウトさせるには、このクエリ文字列パラメーターを追加します: https://YOUR_DOMAIN/oidc/logout?federated。
アプリケーションが最初のリクエストに追加する不透明な値で、認可サーバーは post_logout_redirect_uri へのリダイレクト時にこの値を含めます。
リクエストで使用する言語リストを制限するための、スペース区切りのロケール一覧です。一覧の先頭のロケールは、テナントで有効になっているロケールと一致している必要があります。
レスポンスメッセージ