设置 Okta
为访问您文档的访客设置 Okta 登录界面。
本指南将引导您设置文档的受保护登录屏幕。在阅读本指南之前,请先完成 启用已验证访问.
要使用 Okta 为您的 GitBook 站点设置经过身份验证的访问,流程如下:
创建一个新的 Okta 应用
首先,登录到 Okta 平台(管理员版本),然后通过点击左侧侧边栏的 Applications 按钮创建一个新的应用集成(或使用现有的)。

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

为其命名并且不要在该页面上编辑其他设置。对于分配,选择适当的复选框。点击 Save。
在下一个屏幕上,复制 Client ID 和 Client Secret。通过点击右上角的下拉菜单,复制位于您的电子邮件地址正下方的 Okta 域名。

我们将需要这些值来配置 Okta 集成。
安装并配置 Okta 集成
导航到您要发布的站点的 Integrations 选项卡并找到 Okta 集成,或直接导航到此处 https://app.gitbook.com/integrations/VA-Okta.

在您的站点上安装该集成。
在站点上安装后,您将看到一个要求您输入 Client ID、Okta Domain 和 Client Secret 的屏幕。

对于 Client ID、Okta Domain(如有,移除 https://
前缀)和 Client Secret,请粘贴您从 Okta 仪表板复制的值。
点击 Save。
复制模态框中显示的 URL 并将其作为登录重定向 URI 输入到 Okta(如下图所示)。点击 Save。

现在,在 GitBook 中,关闭集成模态框并点击 Manage site 按钮。导航到 受众,选择 经过身份验证的访问,并选择 Okta 作为后端。然后,点击 更新受众。转到站点的屏幕并点击 发布。 该站点现在已发布在由您的 Auth0 应用控制的经过身份验证的访问保护之下。要试用,请点击 Visit。系统会要求您使用 Okta 登录,这将确认您的站点已通过 Auth0 发布在经过身份验证的访问保护之下。
为自适应内容配置 Okta(可选)
要在具有经过身份验证访问的 GitBook 站点中启用自适应内容,您需要配置 Okta 应用以在身份验证令牌中包含相关的用户数据作为声明(claims)。
声明是嵌入在发送到 GitBook 的令牌中的键值对。这些声明可用于根据用户的角色、计划、位置或任何其他标识属性动态定制文档。
Okta 支持多种类型的声明:
标准声明 这些是常见的声明(例如
电子邮件
,name
,或组
)可能会默认包含,但通常需要在令牌配置中显式添加以确保一致可用性。自定义声明 您可以使用 Okta 中的自定义用户属性或基于表达式的逻辑来定义自定义声明。 custom user attributes 或基于表达式的逻辑。这些允许您传递高度特定的值——例如计划等级、帐户 ID 或内部团队标志。
将组作为声明 您还可以将 Okta 组作为声明传递,这在定义如“企业用户”或“测试用户”等受众细分时特别有用。这些可以在您的授权服务器的声明配置中进行过滤和映射。
要在 Okta 中添加或自定义声明:
打开您的 Okta 管理控制台。
导航到 Security > API > Authorization Servers.
编辑用于您 GitBook 站点的授权服务器。
在 Claims 选项卡下,添加规则以在令牌中包含所需的声明。
确保您的 GitBook 站点正在正确读取并映射这些声明。
一旦声明被传递到 GitBook,按照 自适应您的内容 中的步骤定义应向谁显示哪些内容。
最后更新于
这有帮助吗?