OpenID ページのシングル・サインオンの変更

貴社の OpenID ページ向けに、シングルサインオン(SSO)を IBM® Verify カスタマイズすることができます。 Verify は SSO のために OpenID Connect を使用して、アプリケーションがユーザーの ID を認証できるようにします。

詳細については、 「 OpenID の設定」、「カスタムアプリケーションでのシングルサインオンの接続」、および「 動的クライアント登録」 を参照してください。

OpenID 用の SSO ページを更新するには、圧縮テーマ・ファイルをダウンロードします。 必要に応じてページを編集し、更新したテーマ・ファイルをテナントにアップロードして戻します。 詳細については、 「テーマの更新」 を参照してください。

HTML マークアップを使用して、ページに対してテキストの変更を行うことができます。 HTML ファイルには、マクロも含まれています。 マクロとは、実行時にデータがレンダリングされる @ 記号間の文字です。 ファイル内のマクロは変更しないでください。

IBM Verify SSO for OpenID ページは、テーマ圧縮ファイル内のtemplates\authentication\oidc\ディレクトリーにあります。

以下の OpenID 用の SSO ページをカスタマイズできます。

同意ページの変更

Openl.ID 認証のSSO実行中にユーザーに表示され、ユーザーの同意を求める同意画面。

同意ページはtemplates\authentication\oidc\consent\default\user_consent.htmlファイルにあります。

このページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $PRIVACY_CONSENT_TEXT_WELCOME$
  • $PRIVACY_CONSENT_TEXT_HEADER$
  • $PRIVACY_CONSENT_TEXT_LOGIN$
  • $PRIVACY_CONSENT_TEXT_LOGOUT$
  • $PRIVACY_CONSENT_TEXT_SUBHEADER$
  • $OIDC_TITLE_CONSENT$
  • $OIDC_BUTTON_PERMIT$
  • $OIDC_BUTTON_DENY$

以下の表に、このページのマクロを示します。

表 1. マクロの定義
マクロ マクロを置換する値
@CHECKBOX_OPTION_REPEAT@ チェックボックスにチェックを入れる必要があるか、無効にする必要があるか、およびアクションイベント。
@CHECKBOX_STYLE_REPEAT@ チェックボックスに適用するスタイル。 これは、チェックボックスを表示または非表示にするために使用されます。
@CLAIM@ 要求されたクレーム。
@CLAIM_LOCALES@ 要求されたクレームのロケール。
@CLIENT_ID@ クライアント ID。
@CLIENT_TYPE@ クライアント・タイプ。
@CONSENT_FORM_VERIFIER@ 同意書確認ツール。
@DISPLAY@ 要求された表示。
@FULLNAME@ 認証済みユーザーのフルネーム。
@JSON_DATA@ 目的志向のスコープに関するデータ。
@MAX_AGE@ 要求された最長存続期間。
@OAUTH_AUTHORIZE_URI@ フォーム送信先のURL。
@OAUTH_CLIENT_COMPANY_NAME@ クライアント(アプリケーション)名。
@OAUTH_CLIENT_NAME@ クライアント(アプリケーション)名。
@OAUTH_OTHER_PARAM_REPEAT@ その他の指定されたパラメータ名。
@OAUTH_OTHER_PARAM_VALUE_REPEAT@ その他の指定されたパラメータ値。
@OAUTH_TOKEN_ENTITLEMENT_DESC_REPEAT@ 同意の対象となる資格の説明。
@OAUTH_TOKEN_ENTITLEMENT_REPEAT@ 同意の対象となる資格。
@OAUTH_TOKEN_ENTITLEMENT_PNAME_REPEAT@ 同意を得る対象となるAPIアクセス権限のパラメータ名。
@OAUTH_TOKEN_ENTITLEMENT_PSTATE_REPEAT@ 同意を求めるAPIアクセス権限の状態のパラメータ名。
@OAUTH_TOKEN_ENTITLEMENT_STATE_REPEAT@ 承認済み権利の現状。
@OAUTH_TOKEN_SCOPE_PNAME_REPEAT@ 同意を得る対象となるスコープのパラメータ名。
@OAUTH_TOKEN_SCOPE_PSTATE_REPEAT@ 同意の対象となるスコープの状態のパラメータ名。
@OAUTH_TOKEN_SCOPE_REPEAT@ 範囲については別途合意が必要である。
@OAUTH_TOKEN_SCOPE_STATE_REPEAT@ 承認済み範囲の現状。
@OAUTH_TOKEN_SCOPE_DESC_REPEAT@ 同意の対象となるスコープの説明。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@PREFERNAME@ 認証済みユーザーの優先名。
@PRIVACY_SCOPE_ACCESSTYPE_REPEAT@ 同意の対象となるプライバシー・アクセス・タイプ。
@PRIVACY_SCOPE_ATTR_REPEAT@ 同意の対象となる属性。
@PRIVACY_SCOPE_ATTRVALUE_REPEAT@ 同意の対象となる属性値。
@PRIVACY_SCOPE_DESC_REPEAT@ 同意の対象となるプライバシー情報の範囲の説明。
@PRIVACY_SCOPE_DESC_ALT_REPEAT@ 同意の対象となるプライバシー情報の範囲のカスタム説明。
@PRIVACY_SCOPE_PNAME_REPEAT@ 同意の対象となるプライバシー情報の範囲のパラメーター名。
@PRIVACY_SCOPE_PSTATE_REPEAT@ 同意の対象となるプライバシー情報の目的の状態のパラメーター名。
@PRIVACY_SCOPE_PURPOSE_REPEAT@ 同意の対象となるプライバシー情報の目的。
@PRIVACY_SCOPE_REPEAT@ 同意の対象となるプライバシー情報の範囲。
@PRIVACY_SCOPE_REQUIRED_REPEAT@ 当該プライバシー情報範囲を同意の対象にする必要があるかどうか。
@PRIVACY_SCOPE_RSLV_DESC_REPEAT@ 同意の対象となるプライバシーに関する範囲の詳細。
@PRIVACY_SCOPE_STATE_REPEAT@ 同意の対象となるプライバシー情報の範囲の状態の値。
@PRIVACY_SCOPE_TERMSOFUSE_REPEAT@ EULA のご利用条件の URI。
@REALMNAME@ 認証済みユーザーのレルム名。
@REDIRECT_URI@ リクエストされたリダイレクトURI。
@RESPONSE_TYPE@ 要求された応答タイプ。
@STATE@ 要求された状態。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。
@UI_LOCALES@ 要求された UI ロケール。
@USERNAME@ ユーザーのログイン ID。
デバイス・フロー・ページの変更

OpenID 用の SSO のプロバイダー構成で付与タイプとしてデバイス・フロー・フィールドが選択された場合にユーザーに表示される以下のページ。

デバイス・フロー・ページは、templates\authentication\oidc\device_flow\defaultディレクトリーにあります。

デバイス・フロー・ページは、以下のとおりです。

「ユーザー認証拒否」ページを編集する

このページは、OpenID 用の SSO の認証が拒否された場合に表示されます。 user_authorize_denied.htmlファイルを更新して、ページを変更します。

適応型アクセス検証ページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $OIDC_TITLE_USERAUTH_RESULT$
  • $OIDC_TEXT_USERAUTH_COMPLETE$
  • $OIDC_TEXT_USERAUTH_DENIED$
  • $OIDC_BUTTON_ENTER_ANOTHER$

以下の表に、このページのマクロを示します。

表 2. マクロの定義
マクロ マクロを置換する値
@ACTION@ フォームは URL へ送信され、ユーザーの認証エンドポイントに戻ります。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。
@OAUTH_CLIENT_NAME@ クライアント(アプリケーション)名。
@OAUTH_CODE@ このOIDCデバイスフローのユーザーコード。
ユーザー許可エラー・ページの変更

OpenID 用の SSO の認証が行われると表示されるページ。 user_authorize_error.htmlファイルを更新して、ページを変更します。

適応型アクセス検証ページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $OIDC_TITLE_USERAUTH_RESULT$
  • $OIDC_TEXT_USERAUTH_ERROR$
  • $OIDC_BUTTON_ENTER_ANOTHER$

以下の表に、このページのマクロを示します。

表 3. マクロの定義
マクロ マクロを置換する値
@ACTION@ フォームは URL へ送信され、ユーザーの認証エンドポイントに戻ります。
@ERROR_CODE@ エラー・コード。
@ERROR_DESCRIPTION@ エラーの説明。
@OAUTH_CODE@ このOIDCデバイスフローのユーザーコード。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。
ユーザー許可入力ページの変更

ユーザー入力用に OpenID 用の SSO の認証時に表示されるページ。 user_authorize_input.htmlファイルを更新して、ページを変更します。

適応型アクセス検証ページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $OIDC_TITLE_USERAUTH$
  • $OIDC_TEXT_USERAUTH_ENTER$
  • $OIDC_TEXT_USERAUTH_CODE$
  • $OIDC_BUTTON_SUBMIT$

以下の表に、このページのマクロを示します。

表4. マクロの定義
マクロ マクロを置換する値
@ACTION@ 実行されるアクション。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。
ユーザー許可の許可ページの変更

このページは、OpenID 用の SSO の認証が成功した場合に表示されます。 user_authorize_permitted.htmlファイルを更新して、ページを変更します。

適応型アクセス検証ページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $OIDC_TITLE_USERAUTH_RESULT$
  • $OIDC_TEXT_USERAUTH_COMPLETE$
  • $OIDC_TEXT_USERAUTH_PERMITTED$
  • $OIDC_BUTTON_ENTER_ANOTHER$

以下の表に、このページのマクロを示します。

表5. マクロの定義
マクロ マクロを置換する値
@ACTION@ フォームは URL へ送信され、ユーザーの認証エンドポイントに戻ります。
@OAUTH_CLIENT_NAME@ クライアント(アプリケーション)名。
@OAUTH_CODE@ このOIDCデバイスフローのユーザーコード。
@OAUTH_TOKEN_ENTITLEMENT_DESC_REPEAT@ 利用可能な場合、権利内容の説明。
@OAUTH_TOKEN_ENTITLEMENT_REPEAT@ 承認された権利。
@OAUTH_TOKEN_SCOPE_DESC_REPEAT@ 利用可能な場合は、スコープの説明。
@OAUTH_TOKEN_SCOPE_REPEAT@ 承認されたスコープ。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。
ログアウト用フロントエンドページの編集

アプリケーションのフロントチャネルログアウトエンドポイントを呼び出すiframeをレンダリングするために表示される、ログアウト用フロントチャネルページ。

templates\authentication\oidc\logout\default\logout_frontchannel.html ログアウトのフロントエンドページは、ファイル内にあります。

このページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $OIDC_TITLE_LOGOUT_FRONTCHANNEL$
  • $OIDC_TEXT_LOGOUT_FRONTCHANNEL_HEADER$

以下の表に、このページのマクロを示します。

表7. マクロの定義
マクロ マクロを置換する値
@ACTION@ このフォームの送信先は URL です。
@PRM_NAME_REPEAT@ フォームで送信する必要があるパラメータ名。
@PRM_VALUE_REPEAT@ フォームで送信する必要があるパラメータ値。
@SID_NAME_REPEAT@ インデックス付きセッションIDのパラメータ名。
@SID_VALUE_REPEAT@ インデックス付きセッションIDパラメータ名の値。
@STATUS_NAME_REPEAT@ インデックス化されたステータスパラメータ名。
@IFRAME_ID_REPEAT@ インデックス付きiframe ID。
@IFRAME_SRC_REPEAT@ フロントチャネルのログアウトエンドポイント。
@IFRAME_ATTR_REPEAT@ iframe の属性。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。

SSOの OpenID ページでページヘッダー、フッター、およびスタイルを変更するには、 「共通ブランディングの作成」 を参照してください。

ログアウト概要ページの編集

ログアウト処理の最後に、エラーが発生せず、ログアウト後のリダイレクト先URIへの転送も行われない場合、ユーザーにログアウトの概要ページが表示されます。

ログアウトの概要ページは、ファイル templates\authentication\oidc\logout\default\logout_summary.html 内にあります。

このページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $OIDC_TITLE_LOGOUT_SUMMARY$
  • $OIDC_TEXT_LOGOUT_SUMMARY_HEADER$
  • $OIDC_TEXT_LOGOUT_SUMMARY_APPNAME$
  • $OIDC_TEXT_LOGOUT_SUMMARY_RESULT$
  • $OIDC_TEXT_LOGOUT_SUMMARY_CAUSE$

以下の表に、このページのマクロを示します。

表8. マクロの定義
マクロ マクロを置換する値
@APPNAME_REPEAT@ シングルサインオンに関連するアプリケーション名。
@RESULT_REPEAT@ シングルログアウトの結果。
@CAUSE_REPEAT@ 結果の説明。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。

SSOの OpenID ページでページヘッダー、フッター、およびスタイルを変更するには、 「共通ブランディングの作成」 を参照してください。

一般エラー・ページの変更

OpenID 用の SSO の認証エラーが発生した場合にユーザーに表示される一般エラー・ページ。

一般エラー・ページは、templates\authentication\oidc\error\default\oidc_generic_error.htmlファイルにあります。

このページでは、以下のラベルを使用できます。 これらのラベルのテキストを更新するには、 「ラベルのカスタマイズ」 を参照してください。
  • $GENERIC_ERROR_TITLE$
  • $GENERIC_ERROR_HEADER$

以下の表に、このページのマクロを示します。

表9. マクロの定義
マクロ マクロを置換する値
@ERROR_CODE@ エラーコード。
@ERROR_DESCRIPTION@ エラーの詳細。
@PAGE_FOOTER@ ページのフッターが含まれている HTML。 このコードは、footer.html 共通テンプレートをカスタマイズすることで変更できます。
@PAGE_HEADER@ ページのヘッダーが含まれている HTML。 このコードは、header.html 共通テンプレートをカスタマイズすることで変更できます。
@RESTART_AUTH@ URL を使用して、新しい認証リクエストをトリガーし、再認証を強制します。
@RESUME_AUTH@ URL を実行して、承認リクエストを再開してください。
@THEME_ID@ 登録済みのテンプレート・テーマの ID。

SSOの OpenID ページでページヘッダー、フッター、およびスタイルを変更するには、 「共通ブランディングの作成」 を参照してください。