Skip to main content

在企业上安装 GitHub App

可以在企业上安装 GitHub Apps 来管理企业帐户并执行企业级操作。

谁可以使用此功能?

Enterprise owners can install GitHub Apps on their enterprise. App managers cannot install apps at the enterprise level.

注意

企业安装的 GitHub Apps 处于公共预览版,可能会发生更改。

关于在企业上安装 GitHub Apps

企业安装的 GitHub Apps 是请求企业级权限并可以在企业帐户上执行操作的应用。 与组织或用户安装不同,它们无权访问任何组织或仓库权限,它们只管理企业本身。

企业所有者在企业上安装 GitHub App 后,该应用将获得所请求的企业权限。 这些权限允许应用执行创建企业内组织、跨组织安装应用程序和管理 SCIM 预配等操作。

在企业上安装 GitHub App 的要求

GitHub App 必须请求企业级权限。 它也可以请求其他权限,但安装时只会被授予企业权限。

应���必须由你的企业或企业内的组织拥有。 不能安装由企业外部帐户拥有的应用。

在企业上安装 GitHub App

要在企业上安装应用,请导航到 GitHub App 安装页面。 应用开发人员可能会提供安装页面作为安装链接,或者你可以在应用的注册中找到它。 URL 类似于 https://github.com/apps/APP-NAME/installations/new,其中 APP-NAME 是 GitHub App 的名称。

如果可以安装应用,则可用安装位置列表中将包括你的企业。 可以选择你的企业来安装应用。

安装后,应用将能够为企业创建安装令牌或登录企业成员,以便在企业级别代表他们操作。 代表用户操作要求用户能够在企业内执行所需操作。 例如,如果应用需要邀请用户加入企业,则用户还必须具有邀请成员加入企业的权限。

企业安装应用的功能

企业安装的 GitHub Apps 不能调用每个企业 API,但已有多个 API 更新为支持 GitHub Apps。 这些 API 和 GraphQL 变更包括:

查看更新日志,了解 GitHub Apps 的新 API 和权限更新。

有关可用权限和 API 终结点的详细信息,请参阅 GitHub 应用程序所需的权限

企业安装的 GitHub Apps 的速率限制

企业安装的 GitHub Apps 的安装令牌与 GitHub Enterprise Cloud 组织的速率限制相同。 速率限制是针对每个安装的。 例如,如果应用安装在企业和两个组织上,则需要 3 个安装令牌才能访问它们,并且每个安装都有完整、独立的速率限制预算。 有关详细信息,请参阅 REST API 的速率限制GraphQL API 的速率限制和节点限制

当前限制

企业安装的 GitHub Apps 目前处于公共预览版,存在以下限制。

API 支持

并非所有 API 都支持企业安装的 GitHub Apps。 随着构建更多权限和更新 API,支持范围将更广。 有关支持企业安装的 GitHub Apps 的 API 和权限的详细信息,请参阅 GitHub 应用程序所需的权限

Webhook 支持

企业安装目前不支持 webhook。 在企业级别安装的应用无法接收企业级活动的 webhook 事件。 将它们安装在组织或仓库上以接收这些资源的 webhook 事件。

组织访问权限

企业安装不会被授予对企业内组织或仓库的访问权限,组织安装 API 除外。 要访问组织或仓库资源,必须将应用单独安装在每个需要访问的组织上。

后续步骤