Creating GitHub Apps for your enterprise

Learn how to create a GitHub App for organizations within your enterprise.

Quem pode usar esse recurso?

Enterprise owners.

Neste artigo

Note

Enterprise-owned GitHub Apps are currently in versão prévia pública and subject to change.

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 "Registrar um Aplicativo 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 "Práticas recomendadas para criar um aplicativo do GitHub."

Step 3: Authorizing or sharing your GitHub App

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

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 "Autorizando aplicativos GitHub."

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 "Compartilhando seu Aplicativo 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 "Instalando um Aplicativo GitHub de terceiros."