Creating GitHub Apps for your enterprise

Learn how to create a GitHub App for your enterprise.

谁可以使用此功能？

Enterprise owners.

本文内容

You can create a GitHub App under your enterprise account. The app can only be installed on organizations within your enterprise, and can only be authorized by members of your enterprise. The app can't be installed on user accounts.

Step 1: Registering a GitHub App

To create a GitHub App, you must first register the app. See 注册 GitHub 应用.

Apps can also be transferred to an enterprise from a member or organization. To transfer an app, see 转让 GitHub 应用程序的所有权.

Step 2: Building a GitHub App

After registering a GitHub App, you will want to write code to make your GitHub App do something. For examples of how to write code, see:

You should aim to follow best practices. See 创建 GitHub 应用的最佳做法.

Step 3: Authorizing or installing your GitHub App

Once your GitHub App is registered, you'll need to make it available for use, either through authorization or installation, depending on the app’s purpose.

Enterprise owners can modify the permissions for apps owned by their enterprise at any time. Permissions changes will be automatically accepted by organizations in the enterprise.

Step 3a: Authorizing your GitHub App

Some GitHub Apps, like Copilot extensions, require authorization but do not need to be installed on an organization. Users in your enterprise can authorize the app to access resources within organizations. However, the app will only have access to GitHub resources where it is installed. See 授权 GitHub Apps.

For apps that require installation to function, you can provide organization owners with an installation link. Once the app is installed, it will have access to the organization's resources. See 共享 GitHub 应用.

Step 4: Installing your GitHub App (if required)

If your GitHub App requires installation (not just authorization), organization owners can use the install link to install the app on their organization. See 从第三方途径安装 GitHub Apps.