将品牌应用于托管登录页面 - Amazon Cognito
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

将品牌应用于托管登录页面

您可能想在身份验证服务和应用程序之间提供一致的用户体验。您可以通过 Amazon SDK 中的自定义表单和后端 API 操作或托管登录来实现此目标。托管登录和经典托管 UI 是应用程序中提供用户池身份验证的组件的 Web 前端。要将托管身份验证服务与应用程序 UX 同步,您有两个自定义选项:品牌编辑器和托管 UI 品牌。您可以在 Amazon Cognito 控制台中使用用户池 API 操作来选择自己的首选体验。

品牌编辑器

品牌编辑器托管登录(最新的用户池 UI 体验)的最新自定义选项。品牌编辑器是一个无代码的可视化编辑器,用于管理托管登录页面的资产和样式,同时提供一组 API 操作,支持以编程方式配置大量配置选项。配置了和托管登录的用户池会自动呈现品牌设计器版本的登录页面。

托管 UI(经典)品牌

托管 UI(经典)品牌体验有两个选项:修改一个具有固定样式选项的层叠样式表(CSS)文件,以及添加自定义徽标图像。您可以在 Amazon Cognito 控制台中或使用 SetUICustomization API 操作来设置这些选项。在该服务推出时,Amazon Cognito 只有这个选项。配置了和托管 UI 品牌版本的用户池会自动呈现经典版本的登录页面。您的功能计划也可能仅支持托管 UI。

注意

品牌编辑器和经典品牌体验会修改托管身份验证服务的视觉属性。目前,您无法修改托管登录页面上显示的文本,只能将本地化应用于几种语言中的一种。有关本地化的更多信息,请参阅托管登录本地化

选择品牌体验并分配样式

在 Amazon Cognito 控制台中,新用户池默认为托管登录品牌体验。您在托管登录可用之前设置的用户池将显示托管 UI(经典)品牌。您可以在托管登录和托管 UI 品牌之间切换。当您更改品牌版本时,Amazon Cognito 会立即将更改应用于您的用户池域的用户交互式页面。在托管登录和托管 UI 中,您的用户池可以为每个应用程序客户端设置一种样式。

每个应用程序客户端可以有不同的品牌样式,但是一个用户池域只能用于托管登录或托管 UI 中的一种。样式是指应用于应用程序客户端的一组自定义设置。每个用户池可以设置一个自定义域和一个前缀域。您可以为自定义域和前缀域分配不同的品牌版本。但是,如果您还有自定义域,则前缀域的功能并不完整:.well-known OIDC 发现端点 提供自定义域的路径。在具有此配置的用户池中,前缀域只能用于不需要端点发现(openid-configuration)的操作。由于用户池的这些属性,您在每个用户池中只能有效使用一种品牌样式。

您可以在已将域设置为托管登录品牌版本的用户池中,为应用程序客户端分配样式。样式是一组视觉设置,由图像文件、显示选项和 CSS 值组成。当您为应用程序客户端分配样式后,Amazon Cognito 会立即将您的更新推送到用户交互式登录页面。Amazon Cognito 会使用您选择的品牌版本及其所应用的自定义设置来呈现这些用户交互式页面。

更新和删除样式

创建样式时,可将其链接到应用程序客户端。要更改应用程序客户端的样式分配,必须先删除原始样式。目前,您无法在样式之间复制设置,必须通过编程方式来实现这一点。要在样式和应用程序客户端之间复制设置,可使用 DescribeManagedLoginBranding API 操作获取某个样式的设置,然后使用 CreateManagedLoginBrandingUpdateManagedLoginBranding 应用这些设置。您无法更改已分配给应用程序客户端的样式,只能删除原始样式并设置新样式。有关通过 API 和 SDK 操作管理样式的更多信息,请参阅托管登录品牌的 API 和 SDK 操作

注意

对于通过编程方式创建或更新品牌样式的请求,请求大小不得超过 2 MB。如果您的请求超过此限制,请将其拆分为多个 UpdateManagedLoginBranding 请求,每组参数的大小均不超过最大请求限制。这些部分更新请求不会将未指定的参数重置为默认值,因此您可以安全地发送它们,而不会影响现有的设置。

您可以在 Amazon Cognito 控制台的托管登录菜单中删除样式。在样式下,选择要删除的样式,然后选择删除样式

简而言之,为域分配品牌的流程包括以下步骤。

  1. 创建域并设置品牌版本

  2. 创建品牌样式,并将其分配给应用程序客户端。

将样式分配给应用程序客户端
  1. 在用户池的菜单中创建域,并将品牌版本设置为托管登录

  2. 导航至托管登录菜单。在样式下,选择创建样式

  3. 选择要为其分配样式的应用程序客户端,或新建一个应用程序客户端

  4. 要开始配置品牌设置,请选择启动品牌编辑器