在示例 React 单页应用程序 (SPA) 中登录用户
本指南使用示例 React 单页应用程序 (SPA) 来演示如何向 SPA 添加身份验证。 此 SPA 允许用户使用你的外部租户登录和退出登录。 此示例使用适用于 JavaScript 的 Microsoft 身份验证库 (MSAL.js) 来处理身份验证。
先决条件
- Visual Studio Code 或其他代码编辑器。
- Node.js。
- 外部租户。 若要创建,可以选择以下方法:
- (推荐)使用 Microsoft Entra 外部 ID 扩展直接在 Visual Studio Code 中设置外部租户。
- 在 Microsoft Entra 管理中心创建新的外部租户。
在 Microsoft Entra 管理中心注册 SPA
若要使应用程序能够让用户通过 Microsoft Entra 登录,必须让 Microsoft Entra 外部 ID 能够感知你创建的应用程序。 应用注册会在应用与 Microsoft Entra 之间建立信任关系。 注册应用程序时,外部 ID 会生成一个称为“应用程序(客户端)ID”的唯一标识符,该值用于在创建身份验证请求时标识应用。
以下步骤演示如何在 Microsoft Entra 管理中心注册应用:
至少以应用程序开发人员的身份登录到 Microsoft Entra 管理中心。
如果你有权访问多个租户,请使用顶部菜单中的“设置”图标 ,通过“目录 + 订阅”菜单切换到你的外部租户。
浏览到“标识”>“应用程序”>“应用注册”。
选择“+ 新建注册”。
在显示的“注册应用程序”页中;
- 输入一个向应用用户显示的、有意义的应用程序名称,例如 ciam-client-app。
- 在“支持的帐户类型”下,选择“仅此组织目录中的帐户” 。
选择“注册”。
成功注册后,会显示应用程序的“概述”窗格。 记录要在应用程序源代码中使用的应用程序(客户端)ID。
若要为应用注册指定应用类型,请执行以下步骤:
- 在“管理”下,选择“身份验证”。
- 在“平台配置”页上,选择“添加平台”,然后选择“单页应用程序”。
- 对于“重定向 URI”,请输入
http://localhost:3000
。 - 选择“配置”以保存更改。
授权管理员同意
注册应用程序后,它会分配有 User.Read 权限。 但由于该租户是外部租户,因此客户用户本身不能同意此权限。 作为管理员,你必须代表租户中的所有用户同意此权限:
从“应用注册”页中,选择创建的应用程序(例如 ciam-client-app)以打开其“概述”页。
在“管理”下选择“API 权限”。
- 选择“为 <租户名称> 授予管理员同意”,然后选择“是”。
- 选择“刷新”,然后验证权限的“状态”下是否显示“已为 <租户名称> 授予”。
创建用户流
按照这些步骤创建可供客户用于登录或注册应用程序的用户流。
至少以外部 ID 用户流管理员身份登录到 Microsoft Entra 管理中心。
如果你有权访问多个租户,请使用顶部菜单中的“设置”图标 ,通过“目录 + 订阅”菜单切换到你的外部租户。
浏览到“标识”>“外部标识”>“用户流”。
选择“+ 新建用户流”。
在“创建”页上执行以下操作:
为用户流输入名称,例如 SignInSignUpSample。
在“标识提供者”列表中,选择“电子邮件帐户”。 此标识提供者使用户能够使用其电子邮件地址登录或注册。
在“电子邮件帐户”下,可以选择两个选项之一。 对于本教程,请选择“电子邮件和密码”。
- 电子邮件和密码:使新用户能够使用电子邮件地址作为登录名称并使用密码作为其第一重身份验证凭据进行注册和登录。
- 电子邮件一次性密码:使新用户能够使用电子邮件地址作为登录名称并使用电子邮件一次性密码作为其第一重身份验证凭据进行注册和登录。 只有在租户级别启用电子邮件一次性密码(“所有标识提供者”>“电子邮件一次性密码”),才能在用户流级别使用此选项。
在“用户属性”下,选择要在用户注册时收集的用户属性。 选择“显示更多内容”即可选择“国家/地区”、“显示名称”和“邮政编码”的属性和声明。 选择“确定” 。 (系统仅在用户首次注册时提示输入属性。)
选择“创建” 。 此时,新的用户流将显示在“用户流”列表中。 如果需要,请刷新页面。
若要启用自助式密码重置,请使用启用自助式密码重置一文中的步骤。
将 SPA 与用户流关联
为了让客户用户在使用你的应用时看到注册或登录体验,你需要将自己的应用与用户流相关联。 尽管许多应用程序可与用户流相关联,但单个应用程序只能与一个用户流相关联。
在边栏菜单中选择“标识”。
依次选择“外部标识”和“用户流”。
在“用户流”页中,选择之前创建的用户流名称,例如 SignInSignUpSample。
在“使用”下,选择“应用程序”。
选择“添加应用程序”。
从列表中选择应用程序(如 ciam-client-app),或使用搜索框查找应用程序,然后将其选中。
选择“选择”。
将应用与用户流关联后,可以通过在 Microsoft Entra 管理中心内模拟用户在应用程序中的注册或登录体验来测试用户流。 为此,请使用测试注册和登录用户流中所述的步骤。
克隆或下载示例 SPA
若要获取示例应用程序,可以从 GitHub 克隆它或将其下载为 .zip 文件。
若要克隆示例,请打开命令提示符并导航到要创建项目的位置,然后输入以下命令:
git clone https://github.com/Azure-Samples/ms-identity-ciam-javascript-tutorial.git
下载示例。 将其提取到名称长度小于 260 个字符的文件路径。
安装项目依赖项
在示例项目的根目录中打开终端窗口,输入以下代码片段以导航到项目文件夹:
cd 1-Authentication\1-sign-in-react\SPA
安装项目依赖项:
npm install
配置示例 SPA
打开 SPA\src\authConfig.js,将以下内容替换为从 Microsoft Entra 管理中心获取的值:
- 查找
Enter_the_Application_Id_Here
并将其替换为之前注册的应用的应用程序(客户端)ID。 Enter_the_Tenant_Subdomain_Here
并将其替换为目录(租户)子域。 例如,如果租户主域为contoso.onmicrosoft.com
,请使用contoso
。 如果没有租户名称,请了解如何读取租户详细信息。
- 查找
保存文件。
运行项目并登录
所有需要的代码片段均已添加,因此,现在可以在 Web 浏览器中调用和测试应用程序。
通过选择“终端”>“新终端”打开一个新的终端。
运行以下命令以启动 Web 服务器。
cd 1-Authentication\1-sign-in-react\SPA npm start
打开 Web 浏览器并导航到
http://localhost:3000/
。使用注册到外部租户的帐户登录。
登录后,“退出登录”按钮旁边会显示显示名称。