Observação
Os itens instalados pela empresa GitHub Apps estão em prévia pública e sujeitos a alterações.
Sobre a instalação de GitHub Apps na sua empresa
GitHub Apps instalados pela empresa são aplicativos que solicitam permissões de nível corporativo e podem realizar operações na sua conta corporativa. 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 instala um GitHub App em sua 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 em sua empresa
O GitHub App deve solicitar permissões de 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.
Instalando um GitHub App em sua empresa
Para instalar um aplicativo em sua empresa, navegue até a GitHub App página de instalação. 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, onde 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
Instalação empresarial GitHub Apps não pode chamar todas as APIs corporativas, mas várias APIs já foram atualizadas para suportar GitHub Apps. 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 GitHub App instalações em suas organizações
- Gerenciar propriedades do repositório personalizado da empresa
- Chame as APIs SCIM corporativas
Verifique o changelog para 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 aplicativos GitHub.
Limites de taxa para GitHub Apps instalado pela empresa
O token de instalação de uma empresa instalada GitHub Apps tem o mesmo limite de taxa que uma GitHub Enterprise Cloud organização. 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 taxas e limites de consultas para a API GraphQL.
Limitações atuais
Os GitHub Apps instalados pela empresa estão atualmente em prévia pública com as seguintes limitações.
Suporte à API
Nem todas as APIs oferecem suporte à instalação empresarial GitHub Apps ainda. À 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 as permissões que dão suporte à GitHub Appsinstalação empresarial, consulte Permissões necessárias para 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.
Se você precisar instalar o mesmo aplicativo em muitas organizações, poderá automatizar isso com uma API. Confira Automatizando instalações de aplicativo nas organizações da sua empresa.
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 Revisão e modificação de aplicativos GitHub instalados.