登录体验

概述

登录体验模块用于自定义平台登录页面的外观、登录方式、注册设置和密码策略。通过该模块，管理员可以无需编写代码即可定制用户的登录和注册流程。

导航路径: 侧边栏 -> 登录体验

页面布局

登录体验配置页面分为左右两栏：

• 左侧: 配置表单，包含品牌设置、登录方式、注册设置、密码策略和法律条款
• 右侧: 实时预览面板，配置变更后可即时查看登录页面的效果

品牌设置

自定义登录页面的品牌元素。

字段	说明
Logo	登录页面 Logo 图片的 URL（最多 500 字符）
深色 Logo	深色模式下的 Logo URL
Favicon	浏览器标签页图标 URL
主色调	登录页面的主题颜色，十六进制格式（如 #1890ff）
深色模式主色调	深色模式下的主题颜色（如 #177ddc）

主色调会应用于登录按钮、链接文字等关键 UI 元素，配置后右侧预览面板会实时更新效果。

登录方式

配置用户可以使用哪些方式进行登录。支持添加多种登录方式。

登录方式配置项

每种登录方式包含以下设置：

字段	说明
标识符	用户使用的凭证类型（用户名 / 邮箱 / 手机号）
密码登录	是否启用密码方式登录
验证码登录	是否启用验证码方式登录

可选标识符

标识符	值	说明
用户名	username	使用用户名作为登录标识
邮箱	email	使用邮箱地址作为登录标识
手机号	phone	使用手机号码作为登录标识

常见登录方式组合

组合	标识符	密码	验证码
用户名密码登录	username	是	否
邮箱密码登录	email	是	否
邮箱验证码登录	email	否	是
邮箱密码+验证码	email	是	是
手机验证码登录	phone	否	是

注意: 使用验证码登录需要先在"连接器"模块中配置并启用对应的邮件或短信连接器。

注册设置

配置用户注册流程的相关策略。

字段	说明
注册标识符	注册时需要提供的标识符（支持多选：用户名、邮箱、手机号）
需要密码	注册时是否必须设置密码
需要验证	注册时是否需要验证邮箱或手机号

注册标识符

注册标识符决定了用户注册时需要提供的身份信息。可以同时选择多个标识符。

• 用户名: 用户必须设置一个唯一的用户名
• 邮箱: 用户必须提供邮箱地址
• 手机号: 用户必须提供手机号码

注册验证

当启用 "需要验证" 后，系统会在注册流程中向用户发送验证码（邮件或短信），用户需输入正确的验证码才能完成注册。

前提条件: 使用验证功能需要先配置对应的邮件或短信连接器。

密码策略

配置平台的密码强度要求。

字段	说明	默认值
最小长度	密码的最少字符数（范围 6~32）	8
要求大写字母	密码是否必须包含大写字母	否
要求小写字母	密码是否必须包含小写字母	是
要求数字	密码是否必须包含数字	是
要求特殊字符	密码是否必须包含特殊字符	否

密码策略会应用于以下场景：

• 用户注册时设置密码
• 用户修改密码
• 管理员重置用户密码

法律条款

配置登录和注册页面展示的法律条款链接。

字段	说明
使用条款 URL	服务条款页面的链接地址
隐私政策 URL	隐私政策页面的链接地址

配置后，登录和注册页面底部会展示指向这些页面的链接。

API 参考

获取登录体验配置

GET /api/v1/sign-in-experience

更新登录体验配置

PATCH /api/v1/sign-in-experience

请求示例：

{
  "branding": {
    "logo_url": "https://example.com/logo.png",
    "primary_color": "#1890ff"
  },
  "sign_in": {
    "methods": [
      {
        "identifier": "username",
        "password": true,
        "verification_code": false
      },
      {
        "identifier": "email",
        "password": true,
        "verification_code": true
      }
    ]
  },
  "sign_up": {
    "identifiers": ["username", "email"],
    "password": true,
    "verify": true
  },
  "password_policy": {
    "min_length": 8,
    "uppercase": true,
    "lowercase": true,
    "numbers": true,
    "special_chars": false
  },
  "terms_of_use_url": "https://example.com/terms",
  "privacy_policy_url": "https://example.com/privacy"
}

最佳实践

1. 先配置连接器: 如果需要验证码登录或注册验证，请先在"连接器"模块中配置好邮件或短信连接器
2. 密码策略适度: 过于严格的密码策略可能影响用户体验，建议根据业务安全需求合理设置
3. 测试登录流程: 每次修改登录体验配置后，建议打开登录页面实际测试一次完整的登录流程
4. 品牌一致性: Logo 和主色调应与你的产品品牌保持一致