2.2.5.3.2. login(options)
ログインフォームへのリダイレクト (オプションは redirectUri や prompt フィールドのある任意のオブジェクト) です。
オプションはオブジェクトです。ここでは、以下のようになります。
- redirecturi - ログイン後にリダイレクトする URI を指定します。
-
prompt - このパラメーターは、Red Hat Single Sign-On サーバー側でログインフローを若干カスタマイズできるようにします。たとえば、値の
loginの場合、ログイン画面の表示を強制します。promptパラメーターの詳細および使用できるすべての値は、「パラメーター転送セクション」を参照してください。 -
maxAge - ユーザーがすでに認証されている場合にのみ使用します。ユーザーの認証が発生した時点の最大時間を指定します。ユーザーが
maxAgeよりも長い期間認証されている場合、SSO は無視されるため、再認証が必要になります。 - loginHint - ログインフォームの username/email フィールドを事前に入力するのに使用されます。
-
スコープ - scope パラメーターを Red Hat Single Sign-On ログインエンドポイントに転送するのに使用します。スコープのスペースで区切られたリストを使用します。通常、これらは特定のクライアントで定義される「クライアントスコープ」を参照します。スコープの
openidは、アダプターによって常にスコープのリストに追加されることに注意してください。例えば、スコープオプションのaddress phoneを入力すると、Red Hat Single Sign-On へのリクエストにはスコープパラメーターscope=openid address phoneが含まれます。 - idpHint - Red Hat Single Sign-On に対して、ログインページの表示を省略し、代わりに指定されたアイデンティティープロバイダーに自動的にリダイレクトするように指示するために使用されます。詳細は、Identity Providerのドキュメントを参照してください。
-
action - 値が
registerの場合は登録ページにリダイレクトされますが、それ以外の場合はログインページにリダイレクトされます。 - locale - OIDC 1.0 仕様のセクション 3.1.2.1 に従って、「ui_localesクエリーパラメーターを設定します。
- kcLocale - UI に必要な Keycloak ロケールを指定します。これは、Keycloak サーバーに cookie を設定し、ユーザーのプロファイルを新しい優先ロケールに更新するよう指示するロケールパラメーターとは異なります。
-
cordovaOptions - Cordova in-app-browser (該当する場合) に渡される引数を指定します。
hiddenオプションおよびlocationオプションは、これらの引数の影響を受けません。利用可能なすべてのオプションはhttps://cordova.apache.org/docs/en/latest/reference/cordova-plugin-inappbrowser/ で定義されています。使用例:{ zoom: "no", hardwareback: "yes" };