メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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が設定されていない場合は、サーバーは、Dashboardに最初に設定されているAllowed Logout URLsにユーザーをリダイレクトします。
詳細については、「OIDCエンドポイントを使用してユーザーをAuth0からログアウトする」をお読みください。

備考

  • ユーザーをソーシャルIDプロバイダーからログアウトさせることは一般的ではないため、ソーシャルIDプロバイダーにfederatedクエリ文字列パラメーターを使う前に、ユーザーエクスペリエンスを考慮してください。
  • id_token_hintlogout_hintを両方提供する場合は、logout_hint値がid_token_hintのsidクレームと一致しなければなりません。
  • id_token_hintclient_idを両方提供する場合は、client_id値がid_token_hintaudクレームと一致しなければなりません。
  • id_token_hintが提供されない場合は、ユーザーのセッションIDと一致するlogout_hintが提供されない限り、ユーザーに同意が求められます。
  • POST HTTPメソッドもこの要求でサポートされています。POSTを使用する際は、要求パラメーターは要求のボディーで、クエリ文字列ではなくフォームパラメーターとして提供される必要があります。フェデレーテッドパラメーターにはtrueまたはfalseの値が必要です。
  • これはOIDC RP起点ログアウトの仕様に準拠しています。

詳しい情報

Parameters

id_token_hint
string
[推奨]以前ユーザーに発行されたIDトークンです。これはログアウトするユーザーを示すために使用されます。
logout_hint
string
ログアウトするユーザーを示す、任意のsid(セッションID)値です。id_token_hintが使用不可のときに提供する必要があります。
post_logout_redirect_uri
string
ユーザーをログアウト後にリダイレクトするURLです。
client_id
string
アプリケーションのclient_idです。
federated
string
ユーザーをIDプロバイダーからログアウトするためにこのクエリ文字列パラメーターを追加します:https://YOUR_DOMAIN/oidc/logout?federated
state
string
認可サーバーがpost_logout_redirect_uriへのリダイレクトに含める初期要求に対してアプリケーションが追加する不透明な値です。
ui_locales
string
要求の言語リストを制限するために使用されるスペースで区切りのロケールのリストです。リストの最初のロケールはテナントで有効になっているロケールと一致する必要があります。

Response

StatusDescription
200正常にログアウトされました
400不正な要求です。必要なパラメーターが欠けている可能性があります