设置 Okta

为访问您文档的访客设置 Okta 登录界面

本指南将引导您设置受保护的文档登录界面。在阅读本指南之前，请确保您已先完成 启用认证访问.

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

1

创建一个新的 Okta 应用

在您的 Okta 仪表板中创建一个 Okta 应用。

2

安装并配置 Okta 集成

安装 Okta 集成并添加所需的配置。

3

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

配置 Okta 以在 GitBook 中与自适应内容配合使用。

创建一个新的 Okta 应用

首先，登录 Okta 平台（管理员版本），通过点击左侧边栏的 Applications 按钮创建一个新的应用集成（或使用已有的）。

点击 Create App Integration 并选择 OIDC - OpenID Connect 作为登录方法。然后选择 Web Application 作为应用类型。

为其命名并不要更改该页面上的其他设置。对于分配，选择适当的复选框。点击保存。

在下一个屏幕中，复制 Client ID 和 Client Secret。通过点击右上角的下拉菜单，在您的电子邮件地址下方复制 Okta 域。

我们将需要这些值来配置 Okta 集成。

安装并配置 Okta 集成

导航到要发布的站点的 Integrations 选项卡并找到 Okta 集成。

在您的站点上安装该集成。

在站点上安装后，您将看到一个提示输入 Client ID、Okta Domain 和 Client Secret 的界面。

对于 Client ID、Okta Domain（如果有，请移除 https://前缀）和 Client Secret，请粘贴您从 Okta 仪表板复制的值。

点击保存。

复制模态中显示的 URL，并在 Okta 中将其作为登录重定向 URI 输入（如下图所示）。点击保存。

现在，在 GitBook 中，关闭集成模态并点击管理站点按钮。导航到 受众，选择 认证访问，并选择 Okta 作为后端。然后，点击 更新受众。转到站点的界面并点击 发布。 该站点现在已发布在由您的 Auth0 应用控制的经过身份验证的访问后面。要进行测试，请点击访问。您将被要求使用 Okta 登录，这将确认您的站点已使用 Auth0 置于经过身份验证的访问保护之后。

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

要在具有经过身份验证访问的 GitBook 站点中启用自适应内容，您需要配置 Okta 应用以在认证令牌中包含相关的用户数据作为声明（claims）。

声明是嵌入在发送到 GitBook 的令牌中的键值对。这些声明可用于根据用户的角色、计划、位置或任何其他识别属性动态定制文档。

Okta 支持多种类型的声明：

• 标准声明 这些是常见的声明（例如 电子邮件, name，或 组），它们可能默认包含但通常需要在令牌配置中显式添加以确保可用性。

• 自定义声明 您可以在 Okta 中使用以下方式定义自定义声明： 自定义用户属性 或基于表达式的逻辑。这些允许您传递高度具体的值——例如计划层级、帐户 ID 或内部团队标识。

• 将组作为声明 您还可以将 Okta 组作为声明传递，这在定义诸如“企业用户”或“测试用户”之类的受众细分时尤其有用。这些可以在授权服务器的声明配置中进行筛选和映射。

要在 Okta 中添加或自定义声明：

1. 打开您的 Okta 管理控制台。

2. 导航到 Security > API > Authorization Servers.

3. 编辑用于您的 GitBook 站点的授权服务器。

4. 在 Claims 选项卡下，添加规则以在令牌中包含所需的声明。

5. 确保您的 GitBook 站点正确读取并映射这些声明。

一旦声明传入 GitBook，请按照 调整您的内容 中的步骤来定义应向谁显示哪些内容。