设置 OIDC

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

要使用 OIDC 为您的 GitBook 网站设置经过身份验证的访问,流程如下:

1

在您的身份提供者中创建一个新应用

从您的身份提供者的仪表板创建一个应用。

2

安装并配置 OIDC 集成

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

OIDC 代表 OpenID Connect,它是在 OAuth 之上构建的身份层。许多身份提供者遵循 OIDC,而 GitBook 的 OIDC 集成用于经过身份验证的访问,允许您将空间发布在受身份验证保护的访问后面,内容的访问由您的身份提供者控制

由于本指南是面向所有身份提供者的通用指南,某些细节可能会因您的身份提供者而异。出于说明目的,本指南中我们使用 Google 作为身份提供者。

在您的身份提供者中创建一个新应用

要使集成工作,您需要在身份提供者处设置一些内容。

您需要在身份提供者中创建一个新应用。其类型应为“Web 应用”。在 Google 中,您可以在“API 与服务”、“凭据”,然后在“OAuth 2.0 客户端 ID”下创建这些应用。

A screenshot showing creation of an OAuth client in an identity provider

单击“创建凭据”,选择“OAuth 客户端 ID”,将类型选择为“Web 应用”,为其适当命名,并在“已授权的重定向 URI”下输入您从 GitBook 获取的回调 URL。

单击“创建”。记下客户端 ID 和客户端密钥。我们需要这些来完成在 GitBook 中的集成配置。

安装并配置 OIDC 集成

在 GitBook 应用中导航到集成,选择“经过身份验证的访问”作为类别,然后安装 OIDC 集成。将 OIDC 集成安装到您选择的文档站点上。

A GitBook screenshot showing the OIDC integration installation

在站点上安装后,转到配置并记下位于“保存”按钮上方的回调 URL。我们可能需要它来设置身份提供者。

打开您为其安装了该集成的空间的 OIDC 集成配置界面。

它应如下图所示

A GitBook screenshot showing the OIDC configuration screen

对于客户端 ID 和客户端密钥,请粘贴您从身份提供者获得的值。

现在,您需要为您的身份提供者查找授权端点和访问令牌端点。对于 Google,这些是 https://accounts.google.com/o/oauth2/v2/auth 并且 https://oauth2.googleapis.com/token 分别是。

如果您不使用 Google,这些端点将对您而言不同。请查阅您身份提供者的文档以定位这些端点

对于 OAuth 范围,其值将根据您的身份提供者再次不同。在 Google 的情况下,您可以输入 openid.

请查看您身份提供者文档中允许的作用域列表,并输入最小权限作用域的值。我们仅使用访问令牌来验证用户是否已通过身份验证,而不会使用访问令牌来获取任何进一步的信息。因此,输入最小权限的作用域是最佳的安全建议。

点击 保存。

现在,在 GitBook 中,关闭集成模态框并点击 Manage site 按钮。导航到 受众,选择 经过身份验证的访问,并选择 OIDC 作为后端。然后,单击 更新受众。转到站点的屏幕并点击 发布。 该站点现在已发布在由您的 Auth0 应用控制的经过身份验证的访问后面。要试用,请单击“访问”。系统将要求您使用 OIDC 登录,这将确认您的站点已通过 Auth0 置于经过身份验证的访问保护之下。

最后更新于

这有帮助吗?