设置 Azure AD

为你的文档访客设置 Azure AD 登录界面

本指南将带你完成为文档设置受保护的登录界面。在阅读本指南之前，请确保你已经先完成了 启用经过身份验证的访问.

Azure 集成存在一个已知限制：在身份验证后，标题 URL 片段会被移除。用户仍会进入正确的页面，但会被带到页面顶部，而不是 URL 中的标题位置。一旦用户完成身份验证，在该会话期间这种行为将不再发生，用户也会被导向正确的标题。

这是由于微软实施的一项安全措施。

概览

要使用 Azure AD 为你的 GitBook 站点设置经过身份验证的访问，流程如下：

1

在 Azure AD 中创建应用注册

在你的 Microsoft Entra ID 管理仪表板中创建一个 Azure AD 应用注册。

2

在你的站点上安装并配置 Azure AD 集成

安装 Azure AD 集成，并将所需配置添加到你的 GitBook 站点。

3

为自适应内容配置 Azure AD（可选）

配置你的 Azure AD 以与 GitBook 中的自适应内容配合使用。

1. 在 Azure AD 中创建应用注册

首先在你的 Microsoft Entra ID 仪表板中创建一个应用注册。此应用注册将允许 GitBook Azure AD 集成请求令牌，在授予用户访问你的站点之前验证其身份。

1. 登录到你的 Microsoft Entra ID 管理 仪表板.

2. 进入 身份 > 应用程序 > 应用注册 ，位于左侧边栏。

3. 点击 + 新注册， 并为你的注册命名。

4. 在 支持的帐户类型， 选择“仅此组织目录中的帐户（仅默认目录 - 单租户）”.

5. 暂时将重定向 URI 字段留空——你稍后需要填写。

6. 点击 注册 以完成应用注册。

   

   为 GitBook VA 集成注册一个应用。
7. 然后你应该会看到新的应用注册 概览 屏幕。复制并记下 应用程序（客户端）ID 并 目录（租户）ID.

   

   新创建的应用注册概览。
8. 点击 添加证书或机密。你应该会看到以下 证书和机密 界面：

   

   添加证书或机密。
9. 点击 + 新建客户端机密.

10. 为该机密输入合适的描述并点击 添加.

11. 复制并记下 值 字段（不 机密 ID）即你刚创建的机密。

2. 安装并配置 Azure AD 集成

创建 Azure AD 应用注册后，下一步是在 GitBook 中安装 Azure AD 集成，并使用你之前生成的凭据将其与你的 Azure 应用关联：

1. 导航到你已 启用经过身份验证的访问 并希望将 Azure AD 作为身份提供方的站点。

2. 点击 集成 按钮，位于站点设置右上角。

   
3. 点击 已认证访问 从侧边栏中的类别中。

4. 选择 Azure 集成。

5. 点击 安装到此站点.

   
6. 在你的站点上安装集成后，你应该会看到该集成的配置界面：

   
7. 输入 客户端 ID, 租户 ID，以及 客户端机密 值，这些值你在 创建 Azure AD 应用注册 后已复制，然后点击“保存”。

8. 复制 URL 显示的 位于对话框底部.

9. 回到你之前在 Microsoft Entra ID 仪表板中创建的 Azure AD 应用注册。

10. 浏览到 管理 > 身份验证 ，位于侧边栏中。

11. 点击 + 添加平台 并选择 Web 卡片，在打开的面板中。

    
12. 将你之前复制的 GitBook 集成 URL 粘贴到 重定向 URI 字段中，并点击“配置”

    
13. 回到 Azure 集成 安装界面 在 GitBook 中.

14. 关闭集成对话框并点击站点界面中的 设置 选项卡。

15. 浏览到 受众 并选择 身份验证访问 （如果尚未选择）。

16. 选择 Azure 从下拉菜单中 身份验证后端 部分。

17. 点击 更新受众.

    
18. 进入站点的概览界面并点击 发布 如果站点尚未发布。

你的站点现在已发布在受身份验证保护的访问之后，并使用你的 Azure AD 作为身份提供方。

要进行测试，请点击“访问”。系统会要求你使用 Azure 登录，这将确认你的站点已通过 Azure 的身份验证访问进行发布。

在访问已发布内容的 URL 并使用你的 Azure 凭据登录后，你可能会看到一个屏幕，提示你需要向管理员“请求批准”。你的管理员可以通过访问已发布内容的 URL、登录并代表组织授予批准来处理此请求。

3. 为自适应内容配置 Azure AD（可选）

要在你的经过身份验证访问的站点中利用自适应内容功能，请配置 Azure AD 应用注册，以在身份验证令牌中将额外的用户信息作为声明包含进去。

这些声明以键值对的形式表示，会传递给 GitBook，并可用于 自适应内容 ，为你的站点访客动态调整内容。

Azure AD 支持不同类型和级别的声明，每种声明都有各自的设置方法：

• 标准声明：可能包含在令牌中的常见声明，但默认情况下并不总是存在。

Azure AD 会保持令牌大小以优化性能。因此，许多声明 不 默认包含在令牌中，必须由应用显式请求。为确保诸如 电子邮件 , 组 或 角色 之类的声明被包含，它们必须被显式请求为 可选声明.

• 可选声明：可为应用启用的其他预定义声明。

• 自定义声明：来源于 Azure AD 中的自定义用户属性，或通过自定义声明提供程序从外部系统获取的声明。

有关如何在由 Azure AD 应用生成的令牌中包含这些不同类型声明的更多详情，请参阅以下 Microsoft Entra 文档指南：

• 用户属性

• 可选声明

• 自定义声明

在设置并配置好要发送给 GitBook 的正确 claims 后，前往“为你的内容添加适配”继续配置你的站点。