マネージドログインのサインアウトエンドポイント: /logout
/logout エンドポイントは、リダイレクションエンドポイントです。ユーザーをサインアウトし、アプリケーションクライアントの認可サインアウト URL または /login エンドポイントにリダイレクトする必要があります。/logout エンドポイントへの GET リクエストで使用可能なパラメータは、Amazon Cognito マネージドログインのユースケースに合わせて調整されます。
ログアウトエンドポイントは、顧客とのインタラクティブなユーザーセッション用のフロントエンドウェブアプリケーションです。アプリケーションは、このエンドポイントと他のマネージドログインのエンドポイントを、ユーザーのブラウザで呼び出す必要があります。
ユーザーをマネージドログインにリダイレクトして再度サインインさせるには、リクエストに redirect_uri パラメータを追加します。redirect_uri パラメータを含む logout リクエストには、client_id、response_type、scope などの ログインエンドポイント への後続のリクエスト用のパラメータも含める必要があります。
選択したページにユーザーをリダイレクトするには、アプリクライアントに許可されているサインアウト URL を追加します。logout エンドポイントへのユーザーのリクエストに、logout_uri および client_id パラメーターを追加します。logout_uri の値が、許可されているサインアウト URL の 1 つである場合、Amazon Cognito はユーザーをその URL にリダイレクトします。
SAML 2.0 IdP のシングルログアウト (SLO) を使用すると、Amazon Cognito は、まずユーザーを IdP 設定で定義した SLO エンドポイントにリダイレクトします。IdP がユーザーを saml2/logout にリダイレクトすると、Amazon Cognito はリクエストから redirect_uri または logout_uri へのリダイレクトをもう 1 回返します。詳細については、「シングルサインアウトで SAML ユーザーをサインアウトする」を参照してください。
ログアウトエンドポイントは、OIDC またはソーシャル ID プロバイダー (IdP) からユーザーにサインアウトしません。外部 IdP を使用してセッションからユーザーをサインアウトするには、そのプロバイダーのサインアウトページにユーザーを誘導します。
GET /logout
/logout エンドポイントは HTTPS GET のみをサポートします。ユーザープールクライアントは通常、このリクエストをシステムブラウザ経由で行います。ブラウザは通常、Android では Custom Chrome Tab、iOS では Safari View Control です。
パラメータのリクエスト
- client_id
-
アプリのアプリクライアント ID。アプリクライアント ID を取得するには、ユーザープールにアプリを登録する必要があります。詳細については、「アプリケーションクライアントによるアプリケーション固有の設定」を参照してください。
必須。
- logout_uri
-
logout_uri パラメータを使用して、ユーザーをカスタムサインアウトページにリダイレクトします。この値を、ユーザーがサインアウトした後にユーザーをリダイレクトするアプリクライアントの[sign-out URL] (サインアウト URL) に設定します。logout_uri は、client_id パラメータでのみ使用してください。詳細については、「アプリケーションクライアントによるアプリケーション固有の設定」を参照してください。
logout_uri パラメータを使用して、ユーザーを別のアプリクライアントのサインインページにリダイレクトすることもできます。他のアプリクライアントのサインインページを、アプリクライアントで許可されたコールバック URL として設定します。
/logoutエンドポイントへのリクエストで、logout_uri パラメータの値を URL エンコードされたサインインページに設定します。Amazon Cognito では、
/logoutエンドポイントへのリクエストに logout_uri または redirect_uri パラメータのいずれかが必要です。logout_uri パラメータは、ユーザーを別のウェブサイトにリダイレクトします。/logoutエンドポイントへのリクエストに logout_uri パラメータと redirect_uri パラメータの両方が含まれている場合、Amazon Cognito は logout_uri パラメータのみを使用し、redirect_uri パラメータをオーバーライドします。 nonce-
(オプション) リクエストに追加できるランダムな値。指定したノンス値は、Amazon Cognito が発行する ID トークンに含まれます。リプレイ攻撃を防ぐために、アプリは ID トークンの
nonceクレームを検査し、生成したものと比較することができます。nonceクレームの詳細については、「OpenID Connect standard」(OpenID Connect 標準) の「ID token validation」(ID トークンの検証) を参照してください。 - redirect_uri
-
redirect_uri パラメータを使用して、ユーザーをサインインページにリダイレクトし、認証を行います。その値を、サインインした後にユーザーをリダイレクトするアプリクライアントの[Allowed callback URL] (許可されたコールバック URL) に設定します。
/loginエンドポイントに渡す client_id、scope、state、response_type パラメータを追加します。Amazon Cognito では、
/logoutエンドポイントへのリクエストに logout_uri または redirect_uri パラメータのいずれかが必要です。ユーザーを/loginエンドポイントにリダイレクトして再認証し、トークンをアプリケーションに渡すには、redirect_uri パラメータを追加します。/logoutエンドポイントへのリクエストに logout_uri パラメータと redirect_uri パラメータの両方が含まれている場合、Amazon Cognito は redirect_uri パラメータをオーバーライドし、logout_uri パラメータのみを処理します。 - response_type
-
ユーザーがサインインした後に Amazon Cognito から受信する OAuth 2.0 レスポンス。
codeとtokenは、response_type パラメータの有効な値です。redirect_uri パラメータを使用する場合は必須です。
- state
-
アプリケーションがリクエストに state パラメータを追加すると、Amazon Cognito は、
/oauth2/logoutエンドポイントはユーザーをリダイレクトする際に、その値をアプリケーションに返します。この値をリクエストに追加して CSRF
攻撃から保護します。 stateパラメータの値を、URL でエンコードされた JSON 文字列に設定することはできません。この形式に一致する文字列をstateパラメータで渡すには、文字列を base64 にエンコードし、アプリケーション内でデコードします。redirect_uri パラメータを使用する場合は強くお勧めします。
- スコープ
-
redirect_uri パラメータを使用してサインアウトした後に Amazon Cognito にリクエストする OAuth 2.0 スコープ。Amazon Cognito は、
/logoutエンドポイントへのリクエストの scope パラメータを使用してユーザーを/loginエンドポイントにリダイレクトします。redirect_uri パラメータを使用する場合は任意。scope パラメータを含めない場合、Amazon Cognito は scope パラメータを使用してユーザーを
/loginエンドポイントにリダイレクトします。Amazon Cognito がユーザーをリダイレクトし、scopeに自動的にデータを入力する場合、パラメータには、アプリクライアントに対して許可されているすべてのスコープが含まれます。
リクエストの例
例: ログアウトしてユーザーをクライアントにリダイレクトする
Amazon Cognito は、リクエストに logout_uri と client_id が含まれている場合、他のすべてのリクエストパラメータを無視して、値が logout_uri である URL にユーザーセッションをリダイレクトします。この URL は、アプリケーションクライアントの承認済みサインアウト URL である必要があります。
次は、サインアウトと https://www.example.com/welcome へのリダイレクトのリクエスト例です。
GET https://mydomain.auth.us-east-1.amazoncognito.com/logout? client_id=1example23456789& logout_uri=https%3A%2F%2Fwww.example.com%2Fwelcome
例 – ログアウトして別のユーザーとしてサインインするよう指示する
リクエストに logout_uri が省略されているが、認可エンドポイントへの正しい形式のリクエストを構成するパラメータが指定されている場合、Amazon Cognito はユーザーをマネージドサインインにリダイレクトします。ログアウトエンドポイントは、元のリクエストのパラメータをリダイレクト先に追加します。
ログアウトリクエストに追加する他のパラメータは、パラメータのリクエストのリストに含める必要があります。例えば、ログアウトエンドポイントは、identity_provider パラメータまたは idp_identifier パラメータを使用した自動 IdP リダイレクトをサポートしていません。ログアウトエンドポイントへのリクエストの redirect_uri パラメータは、サインアウト URL ではなく、認可エンドポイントにパススルーするサインイン後の URL です。
次に示すのは、ユーザーをサインアウトしてサインインページにリダイレクトし、サインイン後に認可コードを https://www.example.com に提供するリクエストの例です。
GET https://mydomain.auth.us-east-1.amazoncognito.com/logout? response_type=code& client_id=1example23456789& redirect_uri=https%3A%2F%2Fwww.example.com& state=example-state-value& nonce=example-nonce-value& scope=openid+profile+aws.cognito.signin.user.admin