设置 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 中,关闭集成模态并点击管理站点按钮。导航到 受众,选择 认证访问,并选择 OIDC 作为后端。然后,点击 更新受众。转到站点的界面并点击 发布。 该站点现在已发布在由你的 Auth0 应用控制的经过身份验证的访问后面。要试用,请点击“访问”。系统会要求你使用 OIDC 登录,这将确认你的网站已通过 Auth0 发布在经过身份验证的访问后面。

最后更新于

这有帮助吗?