IDE Services Cloud Help

GitHub 验证模块

此身份验证模块允许用户使用他们的 GitHub 凭据登录 Hub。

启用 GitHub 身份验证

为允许已有 GitHub 账户的用户登录 Hub，请启用 GitHub 身份验证模块。

可以通过以下步骤完成此流程：

  1. 在 Hub 中生成回调 URL。 当您为 GitHub 创建身份验证模块时，Hub 会生成用于该服务的回调 URL。 该 URL 用于识别每个登录请求的来源。

  2. 在 GitHub 中生成 Client ID 和密钥。 每个从 Hub 发送到 GitHub 的登录请求都包含唯一标识符。 您在身份验证模块中存储的 ID 和密钥用于告知 GitHub 每个登录请求已获得授权。

  3. 在 Hub 中启用验证模块。 当您生成了 Hub 用于与 GitHub 验证的信息后，请将这些值复制到 Hub 并启用该模块。

  4. 授权 GitHub OAuth 应用程序。 这将授予 OAuth 应用程序读取其用于验证登录请求所需信息的访问权限。 此步骤仅在您使用属于 GitHub 组织的账户，或通过 Allowed organizations (允许的组织) 限制仅组织成员可登录时需要执行。

在 Hub 中生成回调 URL

首先，打开 YouTrack 并为 GitHub 账户创建身份验证模块。创建后，YouTrack 会生成用于授权服务的回调 URL。 创建身份验证模块后，YouTrack 会生成用于授权服务的回调 URL。

在 Hub 中生成回调 URL：

  1. 在 Access Management (权限管理) 部分的 Administration (行政) 菜单中，选择 Auth Modules (验证模块)。

  2. 点击 New module (新模块) 按钮。

    • Select an identity provider (选择身份提供商) 对话框将打开。

      选择一个身份提供商

  3. 在 Select an identity provider (选择身份提供商) 对话框中，选择 GitHub。

    • New GitHub Auth Module (新 GitHub 验证模块) 对话框将打开。

    新 GitHub 验证模块。

  4. 输入新验证模块的名称， Server URL (服务器 URL) ，然后点击 Create (创建) 按钮。

    • Auth Modules (身份验证模块) 页面显示新 GitHub 身份验证模块的设置。

    • Hub 会为您生成在 GitHub 中使用的回调 URL。

    GitHub 授权回调 URL。

  5. 复制 Authorization callback URL (验证回调 URL)。 如果您的浏览器支持此功能，请使用 Copy (COPY) 按钮将 URI 复制到剪贴板。

  6. 点击链接进入 GitHub 的 Register a new OAuth application (注册新的 OAuth 应用) 页面。

在 GitHub 中生成 Client ID 和密钥

  1. 登录您的 GitHub 账户。

  2. 指定一般参数以注册新的 OAuth 应用程序： Application name (应用名称)、 Homepage URL (主页 URL) ，以及可选的 Application description (应用描述)。

  3. 在 Authorization callback URL (验证回调 URL) 内粘贴您从 Hub 的 Auth Module (验证模块) 页面复制的回调 URL。

  4. 点击 Register application (注册应用) 按钮。

    • GitHub 会为您生成设置 Hub 模块所需的凭证，并在页面顶部显示。

在 Hub 中启用验证模块

  1. 复制 GitHub 中的 client ID 并粘贴到 Hub 的 Client ID (客户端 ID) 输入框。

  2. 复制 GitHub 中的 client secret 并粘贴到 Hub 的 Client Secret (客户端密钥) 输入框。

  3. 配置身份验证模块的可选设置。 有关详细信息，请参阅 设置。

  4. 点击 Enable module (启用模块) 按钮。

    • GitHub 身份验证模块已启用。

    • 存储在 Button Image (按钮图像（Button Image）) 设置中的图标会添加到登录对话窗口。 用户可以点击此图标，用其 GitHub 账户进行身份验证。

      GitHubAuthIcon.png

授权 GitHub OAuth 应用程序

当您首次尝试使用 GitHub 身份验证模块登录时，系统会提示您授权访问 GitHub 中的 OAuth 应用程序。

提示授权 GitHub OAuth 应用程序。

如果您此时无法授权应用访问，请在组织设置中授权。 具体说明请参考 GitHub 文档。

设置

字段

描述

类型

显示在 Hub 中启用第三方身份验证的应用程序或服务的名称。

名称

存储身份验证模块的名称。 使用此设置可将该模块与 Auth Modules (验证模块) 列表中的其他身份验证模块区分开。 该名称也会在登录表单中第三方服务图标的工具提示中显示。

按钮图像

显示用于按钮的图像，用户点击该按钮即可使用 GitHub 账户登录 Hub。

验证回调 URL

显示用于在 GitHub 中注册与 Hub 连接的授权回调 URL。

客户端 ID

存储 GitHub 用于验证登录请求的标识符。 您在为应用程序配置授权设置并输入回调 URL 时，在 GitHub 中生成此值。

客户端密钥

存储用于验证 client ID 的密钥或密码。 您在 GitHub 中与 client ID 一起生成此值。

服务器 URL

显示当用户使用 GitHub 账户登录时 Hub 发送登录请求的服务器 URL。

作用域

显示访问请求的范围（scope）。

此字段下方显示的信息可帮助您配置身份验证模块。

允许的组织

限制此验证模块只允许属于 GitHub 指定组织的用户登录。 输入用逗号分隔的组织列表。 如留空，则任何拥有 GitHub 账户的用户都可使用此验证模块登录。

其他设置

以下选项位于页面底部。 这些设置用于管理 Hub 账户创建、组成员资格，并减少空闲连接消耗的处理资源。

选项

描述

用户创建

启用为未注册用户在 Hub 创建账户（这些用户使用已存储于已连接授权服务的账户登录）。 Hub 通过邮件地址判断用户是否已有账户。

自动加入组

当用户使用已存储于已连接授权服务的账户登录时，将其添加至某个组。 您可以选择一个或多个组。 新用户自动加入组后，将继承该组分配的所有权限。

建议您至少为用户分配一个组。 否则，新用户仅会获得当前分配给 All Users (所有用户) 组的权限。

连接超时

设置连接到授权服务的等待时间。 默认设置为 5000 毫秒（5 秒）。

读取超时

设置从授权服务读取和提取用户资料数据的等待时间。 默认设置为 5000 毫秒（5 秒）。

审核

链接至 Hub 中的 Audit Events (审核事件) 页面。 您可以在此页面查看对该身份验证模块所做变更的列表。

操作

页眉中可用以下操作：

操作

描述

设为默认

指定该身份验证模块为您安装环境的默认模块。 同一时间只能有一个身份验证模块设为默认。 如其他模块已设为默认，则该状态会被清除。

仅当当前身份验证模块未设为默认时才会显示该选项。

清除默认

取消该身份验证模块作为您安装环境默认模块的设置。

如无可用身份验证模块设为默认，未验证用户将始终被引导至 Hub 登录页面。

仅当当前身份验证模块设为默认时才会显示该选项。

禁用模块

禁用身份验证模块。

仅当身份验证模块当前已启用时才会显示该选项。

启用模块

启用身份验证模块。

仅当身份验证模块当前为禁用状态时才会显示该选项。

删除模块

将身份验证模块从 Hub 移除。 仅在已配置其他身份验证模块（允许用户登录 Hub 安装）时使用。

2026年 3月 16日
Facebook 身份验证模块GitLab 验证模块