Como instalar um aplicativo do GitHub em sua empresa

Sobre a instalação de GitHub Apps na sua empresa

GitHub Apps instalados pela empresa são aplicativos que solicitam permissões em nível empresarial e podem executar operações na sua conta empresarial. Ao contrário das instalações da organização ou do usuário, eles não têm acesso a nenhuma permissão de repositório ou organização, apenas gerenciam a empresa em si.

Quando um proprietário da empresa instalar um GitHub App na empresa, o aplicativo receberá as permissões corporativas solicitadas. Essas permissões permitem que o aplicativo execute operações como criar organizações na empresa, instalar aplicativos entre organizações e gerenciar provisionamento SCIM.

Requisitos para instalar um GitHub App na sua empresa

O GitHub App deve solicitar permissões em nível empresarial. Ele também pode solicitar outras permissões, mas apenas as permissões corporativas serão concedidas durante a instalação.

O aplicativo deve pertencer à sua empresa ou a uma organização em sua empresa. Você não pode instalar aplicativos pertencentes a uma conta fora de sua empresa.

Sobre a instalação do GitHub App na sua empresa

Para instalar um aplicativo em sua empresa, navegue até a página de instalação do GitHub App. O desenvolvedor do aplicativo pode fornecer isso como um link de instalação ou você pode encontrá-lo no registro do aplicativo. A URL será semelhante a https://github.com/apps/APP-NAME/installations/new, em que APP-NAME é o nome do GitHub App.

Se for possível instalar o aplicativo, a lista de locais de instalação disponíveis incluirá sua empresa. Você pode selecionar sua empresa para instalar o aplicativo.

Após a instalação, o aplicativo poderá criar um token de instalação para sua empresa ou conectar membros da empresa para agir em seu nome no nível da empresa. Agir em nome de um usuário exige que o usuário consiga executar as operações desejadas dentro da empresa. Por exemplo, se o aplicativo precisar convidar um usuário para uma empresa, o usuário também deverá ter permissão para convidar membros para a empresa.

O que os aplicativos instalados pela empresa podem fazer

GitHub Apps instalados pela empresa não podem chamar todas as API empresariais, mas várias APIs já foram atualizadas para dar suporte a aplicativos do GitHub. Essas APIs e mutações do GraphQL incluem:

• Listar e criar organizações em sua empresa
• Gerenciar usuários em sua empresa
• Criar e gerenciar instalações do GitHub App em suas organizações
• Gerenciar propriedades do repositório personalizado da empresa
• Chamar as APIs SCIM corporativas

Verifique o changelog para obter atualizações sobre novas APIs e permissões para GitHub Apps.

Para obter mais informações sobre permissões disponíveis e pontos de extremidade de API, confira Permissões necessárias para os aplicativos GitHub.

Limites de taxa para GitHub Apps instalados pela empresa

O token de instalação de GitHub Apps instalados pela empresa tem o mesmo limite de taxa que uma organização do GitHub Enterprise Cloud. Os limites de taxa são por instalação. Por exemplo, se um aplicativo estiver instalado em uma empresa e em duas organizações, ele precisará de três tokens de instalação para acessá-los e ter um orçamento de limite de taxa completo e independente para cada instalação. Para saber mais, confira Limites de taxa para a API REST e Limites de taxa e limites de nó para a API GraphQL.

Limitações atuais

Os GitHub Apps instalados pela empresa estão em versão prévia pública com as limitações a seguir.

Suporte à API

Nem todas as APIs dão suporte a GitHub Apps instalados pela empresa no momento. À medida que mais permissões forem criadas e as APIs forem atualizadas, o suporte passará a ser mais amplo. Para obter mais informações sobre as APIs e permissões que dão suporte a GitHub Apps instalados pela empresa, confira Permissões necessárias para os aplicativos GitHub.

Suporte ao Webhook

No momento, as instalações empresariais não dão suporte a webhooks. Os aplicativos instalados no nível da empresa não podem receber eventos de webhook para atividades de nível empresarial. Instale-os em organizações ou repositórios para receber eventos de webhook para esses recursos.

Acesso da organização

As instalações empresariais não recebem acesso a organizações ou repositórios em sua empresa, com exceção da API de instalações da organização. Para acessar recursos de organização ou repositório, você deve instalar o aplicativo separadamente em cada organização em que o acesso é necessário.

Próximas etapas

• Para conceder ao aplicativo acesso a organizações específicas, instale-o nessas organizações. Para saber mais, confira Instalando um Aplicativo GitHub de terceiros.
• Saiba mais sobre como gerenciar aplicativos instalados em suas organizações. Para saber mais, confira Revisar e modificar aplicativos do GitHub instalados.