RootAuth 产品快速开始指南

本文帮助您快速了解 RootAuth 的基础使用路径。您可以按照以下步骤完成一个应用的创建、登录体验配置、安全策略设置和开发接入。涉及到具体配置项时，可点击对应文档查看详细说明。

适用对象：首次使用 RootAuth 的管理员、产品负责人和开发人员。

 

1. 了解 RootAuth 的基本工作流

RootAuth 以「应用」为单位管理认证能力。通常，一个 Web 应用、移动应用或业务系统会对应 RootAuth 中的一个应用。

一个典型接入流程包括：

1. 创建应用并配置基础信息。
2. 设置登录和注册页面。
3. 选择用户可使用的认证方式。
4. 配置安全策略和多因素认证。
5. 调整品牌化样式、邮件和短信服务。
6. 通过 Hosted 页面或 API / SDK 接入业务系统。
7. 上线后查看用户、数据概览和行为日志。

 

2. 创建并配置应用

进入 RootAuth 控制台后，先创建应用，并完成应用名称、Logo、端点、回调地址等基础配置。

常用文档：

• 应用配置：配置应用基础信息、端点和认证相关参数。
• 协议配置：配置 OIDC 授权模式、令牌和回调相关参数。

如果您还不确定具体协议参数，可以先完成应用基础信息，后续在开发接入前再补充协议配置。

 

3. 配置登录和注册体验

在「登录控制」中，您可以决定用户看到的登录注册页面形式，以及用户可以使用邮箱、手机号或用户名完成登录和注册。

建议先确认以下问题：

1. 登录和注册是否分成两个页面，还是合并在一个页面。
2. 用户使用邮箱、手机号还是用户名作为账号。
3. 是否允许密码登录、验证码登录或两者同时启用。
4. 如果启用手机号，是否需要限制可注册或登录的区号。

详细配置请参考 登录控制。

配置完成后，可以点击页面右上角「体验登录/注册」，预览终端用户看到的登录和注册页面。

 

4. 开启第三方认证

如果希望用户使用第三方账号登录，可以在「认证配置」中启用对应提供方。

RootAuth 当前帮助中心提供以下配置指南：

• Google
• Telegram
• Facebook

开启第三方认证后，Hosted 登录页会根据配置展示对应登录按钮。通过 API 接入时，您也可以在自己的页面中实现第三方登录入口。

 

5. 配置安全策略

上线前，建议根据业务风险配置注册安全、IP 策略和多因素认证。

常用安全文档：

• 注册安全：配置注册流程中的安全校验和限制。
• IP黑名单：阻止指定 IP 访问认证流程。
• IP白名单：限制仅允许指定 IP 访问。

如果业务对账号安全要求较高，可以开启多因素认证：

• 电子邮箱验证
• OTP（身份验证器应用）
• 短信验证

多因素认证主要影响账号密码登录。第三方登录和验证码登录是否受影响，请以对应功能文档说明为准。

 

6. 设置品牌化内容

品牌化配置用于让认证页面、邮件和短信与您的产品体验保持一致。

您可以优先完成以下配置：

• 样式配置：配置登录页背景、主题色、Logo 等视觉样式。
• 功能配置：配置登录页文案、协议链接、语言切换等功能。
• 第三方邮件服务：配置自定义 SMTP 服务。
• 邮件模板：配置注册、登录、重置密码等邮件内容。
• 国内短信服务：配置国内短信验证码发送服务。
• 国际短信服务：配置国际短信验证码发送服务。

配置完成后，建议发送测试邮件或测试短信，确认服务商凭证、签名和模板可正常使用。

 

7. 接入您的业务系统

RootAuth 支持 Hosted 接入和 API / 前端框架接入。您可以根据团队开发方式选择接入路径。

接入方式	适用场景	文档
API 接入	希望快速使用 RootAuth 托管登录注册页面。	API 模式接入
Vue 接入	业务前端使用 Vue。	Vue 模式接入
React 接入	业务前端使用 React。	React 模式接入

开发接入过程中，如果遇到接口错误，可参考 错误码参考。

 

8. 管理用户和权限

应用上线后，管理员可以在「用户管理」中查看和管理当前应用下的用户、组织和角色。

• 用户：查看用户列表、用户详情和认证信息。
• 组织：管理组织结构。
• 角色：管理角色和权限分配。

如果只需要快速验证登录注册流程，可以先完成用户查看和用户详情确认，组织和角色可在权限管理阶段再配置。

 

9. 查看数据和日志

上线后，您可以通过应用概览和审计日志持续观察用户增长、登录活跃度和异常行为。

• 用户数据概览：查看核心用户数据和趋势。
• 用户行为日志：查看注册、登录、重置密码、二次认证等用户行为。

当用户反馈无法登录、验证码收不到或二次验证失败时，建议优先查看用户行为日志，确认失败原因和发生时间。

 

10. 推荐上线检查清单

正式上线前，建议完成以下检查：

1. 应用名称、Logo、回调地址和协议配置已确认。
2. 登录注册页面已通过「体验登录/注册」预览。
3. 认证方式已按业务需要开启，例如邮箱、手机号或第三方登录。
4. 注册安全、IP 策略和多因素认证已按风险要求配置。
5. 邮件和短信服务已发送测试并确认可用。
6. 开发接入已完成，并能正确处理登录成功和失败场景。
7. 管理员已了解如何查看用户详情、数据概览和用户行为日志。

完成以上步骤后，您就可以将 RootAuth 认证能力接入到正式业务流程中。