ログアウトエンドポイント - Amazon Cognito

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ログアウトエンドポイント

/logout エンドポイントは、リダイレクションエンドポイントです。ユーザーをサインアウトし、アプリクライアントの許可サインアウト URL または /login エンドポイントにリダイレクトする必要があります。/logout エンドポイントへの GET リクエストで使用可能なパラメータは、Amazon Cognito がホストする UI のユースケースに合わせて調整されます。

ユーザーをホストされた UI にリダイレクトして再度ログインするには、リクエストに redirect_uri パラメータを追加します。redirect_uri パラメータを含む logout リクエストには、client_idresponse_typescope などの ログインエンドポイント への後続のリクエスト用のパラメータも含める必要があります。

ログアウトエンドポイントは、顧客とのインタラクティブなユーザーセッション用のフロントエンドウェブアプリケーションです。アプリは、このエンドポイントと他のホストされた UI エンドポイントをユーザーのブラウザで呼び出す必要があります。

選択したページにユーザーをリダイレクトするには、アプリクライアントに許可されているサインアウト URL を追加します。logout エンドポイントへのユーザーのリクエストに、logout_uri および client_id パラメーターを追加します。logout_uri の値が、許可されているサインアウト URL の 1 つである場合、Amazon Cognito はユーザーをその URL にリダイレクトします。

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 パラメータをオーバーライドします。

redirect_uri

redirect_uri パラメータを使用して、ユーザーをサインインページにリダイレクトし、認証を行います。その値を、サインインした後にユーザーをリダイレクトするアプリクライアントの[Allowed callback URL] (許可されたコールバック URL) に設定します。/login エンドポイントに渡す client_idscopestateresponse_type のパラメータを追加します。

Amazon Cognito では、/logout エンドポイントへのリクエストに logout_uri または redirect_uri パラメータのいずれかが必要です。ユーザーを /login エンドポイントにリダイレクトして再認証し、トークンをアプリに渡す場合は、redirect_uri パラメータを追加します。/logout エンドポイントへのリクエストに logout_uri パラメータと redirect_uri パラメータの両方が含まれている場合、Amazon Cognito は logout_uri パラメータのみを使用し、redirect_uri パラメータをオーバーライドします。

response_type

ユーザーがサインインした後に Amazon Cognito から受信する OAuth 2.0 レスポンス。codetoken は、response_type パラメータの有効な値です。

redirect_uri パラメータを使用する場合は必須です。

state

アプリがリクエストに state パラメータを追加すると、Amazon Cognito は/oauth2/logout エンドポイントはユーザーをリダイレクトする際に、その値をアプリに返します。

この値をリクエストに追加して CSRF 攻撃から保護します。

state パラメータの値を、URL でエンコードされた JSON 文字列に設定することはできません。この形式に一致する文字列を state パラメータとして渡すには、文字列を Base64 にエンコードし、アプリ内でデコードします。

redirect_uri パラメータを使用する場合は強くお勧めします。

scope

redirect_uri パラメータを使用してサインアウトした後に Amazon Cognito にリクエストする OAuth 2.0 スコープ。Amazon Cognito は、/logout エンドポイントへのリクエストの scope パラメータを使用してユーザーを /login エンドポイントにリダイレクトします。

redirect_uri パラメータを使用する場合は任意。scope パラメータを含めない場合、Amazon Cognito は scope パラメータを使用してユーザーを /login エンドポイントにリダイレクトします。Amazon Cognito がユーザーをリダイレクトし、scope に自動的にデータを入力する場合、パラメータには、アプリクライアントに対して許可されているすべてのスコープが含まれます。

リクエスト例

例 1: ログアウトしてユーザーをクライアントにリダイレクトする

logout_uriclient_id を除いて、このエンドポイントで使用可能なすべてのクエリパラメータが 認可エンドポイント にパススルーされます。Amazon Cognito は、リクエストに logout_uriclient_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

例 2: ログアウトして別のユーザーとしてサインインするよう指示する

リクエストに logout_uri が省略されているが、許可エンドポイントへの正しい形式のリクエストを構成するパラメータが指定されている場合、Amazon Cognito はホストされた UI サインインにユーザーをリダイレクトします。ログアウトエンドポイントは、元のリクエストのパラメータをリダイレクト先に追加します。ログアウトエンドポイントへのリクエストの 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