我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

GitHub 应用程序和 OAuth 应用程序之间的差异

了解 GitHub 应用程序 和 OAuth 应用程序 之间的差异可帮助您决定要创建哪个应用程序。 在组织或组织内的仓库上安装时,OAuth 应用程序 代表 GitHub 用户,而 GitHub 应用程序 使用它自己的身份。

本文内容

谁可以安装 GitHub 应用程序并授权 OAuth 应用程序?

您可以在您的个人帐户或您拥有的组织中安装 GitHub 应用程序。 如果拥有仓库管理员权限,您可以在组织帐户上安装 GitHub 应用程序。 如果 GitHub 应用程序安装在仓库中,并且需要组织权限,则组织所有者必须批准该应用程序。

默认情况下,只有组织所有者才可管理组织中 GitHub 的设置。 要允许其他用户管理组织中的 GitHub 应用程序,所有者可以向他们授予 GitHub 应用程序管理员权限。 请参阅“GitHub 应用程序”,了解如何在组织中添加和删除 GitHub 应用程序管理员。

相比之下,一旦用户授权 OAuth 应用程序,该应用程序就能代表经身份验证的用户。 例如,您可以授权 OAuth 应用程序查找经身份验证用户的所有通知。 您可以随时撤销 OAuth 应用程序的权限。

警告: 从 OAuth 应用程序 撤销所有权限将会删除应用程序代表用户生成的 SSH 密钥,包括部署密钥

GitHub 应用程序OAuth 应用程序
您必须是组织所有者或者具有仓库管理员权限才能在组织上安装 GitHub 应用程序。 如果 GitHub 应用程序安装在仓库中,并且需要组织权限,则组织所有者必须批准该应用程序。您可以授权 OAuth 应用程序访问资源。
您可以在个人仓库上安装 GitHub 应用程序。您可以授权 OAuth 应用程序访问资源。
您必须是组织所有者、个人仓库所有者或者拥有仓库的管理员权限才能卸载 GitHub 应用程序和删除其访问权限。您可以删除 OAuth 访问令牌以删除访问权限。
您必须是组织所有者或者具有仓库管理员权限才能请求安装 GitHub 应用程序。如果组织应用程序策略已激活,则任何组织成员都可以请求在组织上安装 OAuth 应用程序。 组织所有者必须批准或拒绝请求。

GitHub 应用程序和 OAuth 应用程序可以访问什么?

帐户所有者可以在一个帐户中使用 GitHub 应用程序 ,而不授予对其他帐户的访问权限。 例如,您可以在您的雇主组织中安装第三方构建服务,但决定不授权该构建服务访问您个人帐户中的仓库。 即使安装者离开组织,GitHub 应用程序仍然存在。

授权的 OAuth 应用程序有权访问用户或组织所有者可访问的所有资源。

GitHub 应用程序OAuth 应用程序
安装 GitHub 应用程序将授予该应用程序访问用户或组织帐户所选仓库的权限。授权 OAuth 应用程序将授予该应用程序访问用户可访问资源的权限。 例如,他们可以访问的仓库。
如果管理员从安装中删除仓库,则 GitHub 应用程序的安装令牌将失去对资源的访问权限。当用户失去对资源的访问权限时,例如失去对仓库的写入权限,OAuth 访问令牌也会失去相应的访问权限。
安装访问令牌仅限于指定的仓库,其权限由应用程序创建者选择。OAuth 访问令牌受作用域限制。
GitHub Apps 可以请求单独访问议题和拉取请求,而不访问仓库的实际内容。OAuth 应用程序需要请求 repo 作用域才能访问议题、拉取请求或仓库拥有的任何内容。
GitHub 应用程序不受组织应用程序策略的约束。 GitHub 应用程序只能访问组织所有者授权的仓库。如果组织应用程序策略已激活,则只有组织所有者才能授权安装 OAuth 应用程序。 安装后,OAuth 应用程序将有权访问组织所有者在批准组织内的令牌可见的任何内容。
当安装被更改或删除时,GitHub 应用程序会收到 web 挂钩事件。 当它们对组织资源的访问权限扩大或缩小时,这将告诉应用程序创建者。根据授予用户访问权限的变化,OAuth 应用程序可能会随时失去对组织或仓库的访问权限。 OAuth 应用程序在失去对资源的访问权限时不会通知您。

基于令牌的识别

注:GitHub 应用程序也可以使用基于用户的令牌。 更多信息请参阅“识别和授权 GitHub 应用程序用户”。

GitHub 应用程序OAuth 应用程序
GitHub 应用可以使用带外 JSON Web 令牌格式的私钥请求安装访问令牌。OAuth 应用程序可以通过 Web 请求在重定向后将请求令牌交换为访问令牌。
安装程序将应用程序识别为 GitHub 应用自动程序,例如 @jenkins-bot。访问令牌将应用程序识别为向应用程序授予令牌的用户,例如 @octocat。
安装令牌在预定义的时间(当前为 1 小时)后过期。OAuth 令牌在被客户撤销之前一直保持活动状态。
发出服务器-服务器请求的 GitHub 应用程序 使用安装的最低速率限制为每小时 5,000 个请求。 具有 20 个以上用户的组织安装每小时每个用户将再收到 50 个请求。 具有 20 个以上仓库的安装每小时会为每个仓库再接收 50 个请求。 安装的最大速率限制为每小时 12,500 个请求。 更高的速率限制适用于 GitHub Enterprise Cloud。 更多信息请参阅“GitHub 应用程序的速率限制”。OAuth 令牌使用用户的每小时 5,000 个请求的速率限制。
速率限制的增加可在 GitHub 应用程序级别(影响所有安装)和单个安装级别上授予。速率限制的增加按 OAuth 应用程序授予。 授予该 OAuth 应用程序的每个令牌都会获得增加的上限。
GitHub 应用程序 可以代表用户进行身份验证,这称为用户到服务器请求。 授权流程与 OAuth 应用程序授权流程相同。 用户到服务器令牌可能会过期,可通过刷新令牌进行续订。 更多信息请参阅“刷新用户到服务器访问令牌”和“识别和授权 GitHub 应用程序用户”。OAuth 应用程序 使用的 OAuth 流程代表用户授权 OAuth 应用程序。 这与用于 GitHub 应用程序 用户到服务器授权中使用的流程相同。

请求资源的权限级别

与 OAuth 应用程序不同,GitHub 应用程序具有针对性的权限,只允许它们请求访问所需的资源。 例如,持续集成 (CI) GitHub 应用程序可以请求对仓库内容的读取权限和对状态 API 的写入权限。 另一个 GitHub 应用程序可能没有对代码的读取或写入权限,但仍能管理议题、标签和里程碑。 OAuth 应用程序不能使用精细权限。

访问GitHub 应用程序(readwrite 权限)OAuth 应用程序
访问公共仓库需要在安装过程中选择公共仓库。public_repo 作用域。
访问仓库代码/内容仓库内容repo 作用域。
获取议题、标签和里程碑议题repo 作用域。
获取拉取请求、标签和里程碑拉取请求repo 作用域。
访问提交状态(对于 CI 构建)提交状态repo:status 作用域。
访问部署和部署状态部署repo_deployment 作用域。
通过 web 挂钩接收事件GitHub 应用程序默认包含一个 web 挂钩。write:repo_hookwrite:org_hook 作用域。

仓库发现

GitHub 应用程序OAuth 应用程序
GitHub 应用程序可以访问 /installation/repositories 以查看安装可访问的仓库。OAuth 应用程序可访问用户视图中的 /user/repos 或组织视图中的 /orgs/:org/repos 以查看可访问的资源。
当从安装中添加或删除仓库时,GitHub 应用程序会接收 web 挂钩。在组织内创建新仓库时,OAuth 应用程序为通知创建组织 web 挂钩。

Web 挂钩

GitHub 应用程序OAuth 应用程序
默认情况下,GitHub 应用程序有一个 web 挂钩,可根据配置接收它们有权访问的每个仓库中的事件。OAuth 应用程序请求 web 挂钩作用域为它们需要接收其事件的每个仓库创建仓库 web 挂钩。
GitHub 应用程序使用组织成员的权限接收某些组织级别的事件。OAuth 应用程序请求组织 web 挂钩作用域为它们需要接收其组织级别事件的每个组织创建组织 web 挂钩。

Git 访问

GitHub 应用程序OAuth 应用程序
GitHub 应用程序请求仓库内容权限,并使用安装令牌通过基于 HTTP 的 Git 进行身份验证。OAuth 应用程序请求 write:public_key 作用域,并通过 API 创建部署密钥。 然后您可以使用该密钥来执行 Git 命令。
令牌用作 HTTP 密码。令牌用作 HTTP 用户名。

机器与机器人帐户

机器用户帐户是基于 OAuth 的用户帐户,它使用 GitHub 的用户系统隔离自动系统。

机器人帐户特定于 GitHub 应用,并内置于每个 GitHub 应用程序中。

GitHub 应用程序OAuth 应用程序
GitHub 应用程序机器人不占用 GitHub Enterprise 席位。机器用户帐户占用 GitHub Enterprise 席位。
由于 GitHub 应用程序机器人永远不会被授予密码,因此客户无法直接登录它。机器用户帐户被授予由客户管理和保护的用户名和密码。

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。