修改 OpenID 的单点登录页面

在线编辑

您可以为企业自定义 OpenID 页面的单点登录（SSO）功能 IBM® Verify 。 Verify 使用 OpenID Connect for SSO 以允许应用程序对用户身份进行认证。

如需了解更多信息，请参阅“在自定义应用程序中配置 OpenID 单点登录”和 “动态客户端注册 ”。

要更新 OpenID 的 SSO 页面，请下载压缩主题文件。 根据需要编辑页面，然后将更新后的主题文件上载回租户。 如需了解更多信息，请参阅 “更新主题 ”。

可以使用 HTML 标记对页面进行文本更改。 HTML 文件还包含宏。 宏是在运行时呈现其中数据的 @ 符号之间的字符。 请勿更改文件中的宏。

OpenID 的 IBM Verify SSO 页面位于主题压缩文件中的 templates\authentication\oidc\ 目录。

以下 OpenID 的 SSO 页面可供定制：

修改同意页面

在通过单点登录（SSO）进行 Openl.ID 身份验证时，向用户显示的同意页面，用于请求用户同意。

同意页面位于 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@ 客户机标识。
@CLIENT_TYPE@ 客户机类型。
@CONSENT_FORM_VERIFIER@ 知情同意书核验工具。
@DISPLAY@ 请求的显示。
@FULLNAME@ 已认证用户的全名。
@JSON_DATA@ 基于特定目的的范围数据。
@MAX_AGE@ 请求的最长生存期。
@OAUTH_AUTHORIZE_URI@ 表单提交的目标网址。
@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@ 注册的模板主题的标识。
@UI_LOCALES@ 请求的 UI 语言环境。
@用户名@ 用户登录标识。
修改设备流程页面

在 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@ 注册的模板主题的标识。
@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@ 注册的模板主题的标识。
修改用户授权输入页面

进行 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@ 注册的模板主题的标识。
修改用户授权允许页面

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@ 注册的模板主题的标识。
修改注销同意页面

在由资源提供方（RP）发起的注销流程中，向用户显示的用于请求同意的注销同意页面。

templates\authentication\oidc\logout\default\logout_consent.html 注销同意页面位于 文件中。

此页面上提供了以下标签。 如需更新这些标签上的文本，请参阅 “自定义标签”。
  • $OIDC_TITLE_LOGOUT_CONSENT$
  • $OIDC_TEXT_LOGOUT_CONSENT_HEADER$
  • $OIDC_TEXT_LOGOUT_CONSENT_LOGIN$
  • $OIDC_TEXT_LOGOUT_CONSENT_SUBHEADER$
  • $OIDC_BUTTON_YES$
  • $OIDC_BUTTON_NO$

下表中显示了此页面的宏。

表6。 宏定义
宏 替换宏的值
@ACTION@ 表单提交的目标地址为 URL。
@PRM_NAME_REPEAT@ 需要在表单中提交的参数名称。
@PRM_VALUE_REPEAT@ 需要在表单中提交的参数值。
@PAGE_FOOTER@ 包含页面页脚的 HTML。 可通过定制 footer.html 公共模板来修改此代码。
@PAGE_HEADER@ 包含页面标题的 HTML。 可通过定制 header.html 公共模板来修改此代码。
@THEME_ID@ 注册的模板主题的标识。

若要更改 SSO OpenID 页面上的页眉、页脚和样式，请参阅 “创建通用品牌标识 ”。

修改注销前端页面

用于渲染调用应用程序前端通道注销端点的 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@ 注册的模板主题的标识。

若要更改 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@ 注册的模板主题的标识。

若要更改 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@ 注册的模板主题的标识。

若要更改 SSO OpenID 页面上的页眉、页脚和样式，请参阅 “创建通用品牌标识 ”。