Modificando um registro de aplicativo GitHub

Sobre as GitHub App alterações

Você pode modificar seu GitHub App registro para alterar qualquer uma das configurações que foram selecionadas quando o aplicativo foi registrado inicialmente. Para obter mais informações sobre as configurações que você pode selecionar ao registrar um GitHub App, consulte Registrando um aplicativo GitHub.

Por exemplo, você pode alterar o nome e a descrição de seu aplicativo, as permissões concedidas a ele, os webhooks aos quais seu aplicativo se inscreve ou a visibilidade do aplicativo.

Você também pode optar por testar novos recursos opcionais para seu GitHub App. Confira Ativando recursos opcionais para aplicativos GitHub.

Acessando suas GitHub App configurações

Para modificar um GitHub App, primeiro navegue até a página de configurações do aplicativo.

1. No canto superior direito de qualquer página do GitHub, clique na foto do seu perfil.

2. Acesse as configurações da sua conta.

   • Para um aplicativo de propriedade de uma conta pessoal, clique em Configurações.
   • Para um aplicativo de propriedade de uma organização:
     1. Clique em Suas organizações.
     2. À direita da organização, clique em Configurações.
   • Para um aplicativo de propriedade de uma empresa:
     1. Se você usar Enterprise Managed Users, clique em Sua empresa para ir diretamente para as configurações da conta corporativa.
     2. Se você usar contas pessoais, clique em Suas empresas e, à direita da empresa, clique em Configurações.

3. Navegue até as configurações GitHub App.

   • Para um aplicativo pertencente a uma conta pessoal ou a uma organização:
     1. Na barra lateral esquerda, clique em Developer settings e clique em GitHub Apps.
   • Para um aplicativo de propriedade de uma empresa:
     1. Na barra lateral esquerda, em "Configurações", clique em GitHub Apps.

4. À direita do GitHub App que você deseja modificar, clique em Editar.

Alterando as informações básicas de um GitHub App

Você pode alterar as informações básicas do aplicativo GitHub App, como o nome do aplicativo, a descrição do aplicativo e a URL da home page do aplicativo.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Em "Informações básicas", modifique as GitHub App informações que você gostaria de alterar.
3. Selecione Salvar alterações.

Solicitar a autorização do usuário (OAuth) durante a instalação

Você pode solicitar aos usuários que autorizem seu GitHub App quando o instalarem e gerem um token de acesso de usuário. Ao solicitar a autorização do usuário (OAuth) durante a instalação, você também deve fornecer uma URL de retorno de chamada em que o usuário será redirecionado após autorizar a instalação. Confira Gerando um token de acesso do usuário para um aplicativo GitHub.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Em "Identificar e autorizar usuários", selecione ou desmarque Solicitar autorização de usuário (OAuth) durante a instalação.
3. Em "URL de retorno de chamada", digite a URL completa para redirecionamento após um usuário autorizar a instalação.

Habilitar ou desabilitar o fluxo do dispositivo

Você pode usar o fluxo do dispositivo para autorizar usuários para um aplicativo sem cabeçalho, como uma ferramenta CLI ou gerenciador de credenciais Git. Para obter mais informações sobre como usar o fluxo de dispositivo com GitHub Apps, consulte Gerando um token de acesso do usuário para um aplicativo GitHub.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Em "Identificar e autorizar usuários", selecione ou desmarque Habilitar Fluxo de Dispositivo.

Adicionar ou atualizar uma URL de instalação

Você pode redirecionar as pessoas para uma URL específica depois que elas instalarem seu aplicativo. Confira Registrando um aplicativo GitHub.

Se você selecionar Solicitar autorização de usuário (OAuth) durante a instalação, não será possível inserir uma URL de configuração. Em vez disso, os usuários serão redirecionados para a URL de retorno de chamada como parte do fluxo de autorização, no qual você poderá descrever a configuração adicional. Confira Sobre a URL de retorno de chamada de autorização do usuário.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Em "Pós-instalação", no campo "URL de instalação", insira a URL para a qual você gostaria de redirecionar os usuários depois que eles instalarem o aplicativo.
3. Opcionalmente, se você quiser redirecionar os usuários para a URL de instalação depois que eles atualizarem uma instalação, selecione Redirecionar após atualização. Uma atualização inclui a adição ou a remoção de um repositório para uma instalação. Se a opção "URL de Instalação" estiver em branco, isso será ignorado.

Alterando as permissões de um GitHub App

Você pode alterar as permissões de acesso concedidas a você GitHub App usando as etapas a seguir.

Quando você adiciona novas permissões de repositório, organização ou empresa para um aplicativo, cada conta em que o aplicativo está instalado precisará aprovar as novas permissões. Quando você adicionar as permissões de conta de um aplicativo, cada usuário que autorizou o aplicativo precisará aprovar as alterações de permissão. Em ambos os casos, GitHub enviará um email para cada proprietário ou usuário da organização, notificando-os da solicitação para atualizar as permissões do aplicativo. As permissões atualizadas não entrarão em vigor em uma instalação ou autorização do usuário até que as novas permissões sejam aprovadas. Você pode usar o webhook de instalação para ficar a par quando as pessoas aceitarem novas permissões para seu aplicativo.

Se você remover permissões ou webhooks de seu GitHub App, as alterações entrarão em vigor imediatamente. Se você remover permissões concedidas antes ao aplicativo, o aplicativo não poderá mais acessar esses recursos.

Se você alterar as permissões de um aplicativo de propriedade de uma empresa, as alterações entrarão em vigor imediatamente para todas as instalações do aplicativo na empresa se você for um proprietário da empresa. Se você for um gerenciador de aplicativos, as alterações só serão aceitas automaticamente nas organizações em que você é proprietário da organização.

As atualizações não poderão ser aceitas automaticamente se você adicionar permissões de repositório a um aplicativo pela primeira vez. Nesse caso, cada proprietário da organização precisará aprovar a atualização para que possa escolher a quais repositórios o aplicativo tem acesso.

Alterar as permissões de um aplicativo também pode alterar os webhooks nos quais seu aplicativo pode se inscrever e as ações que seu aplicativo pode executar com a API. Confira Escolhendo permissões para um aplicativo GitHub.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Na barra lateral de GitHub Apps configurações, clique em Permissões & eventos.
3. Nas seções "Permissões do repositório", "Permissões da organização" e "Permissões da conta", modifique as permissões que você gostaria de alterar. Para cada tipo de permissão, selecione "Somente leitura", "Leitura e gravação" ou "Sem acesso" no menu suspenso. Confira Escolhendo permissões para um aplicativo GitHub.
4. Opcionalmente, em "Adicionar uma nota aos usuários", adicione uma nota informando por que você está alterando as permissões solicitadas por GitHub App.
5. Selecione Salvar alterações.

Ativando ou desativando o GitHub App webhook

Você pode configurar seu GitHub App para receber webhooks de eventos específicos em GitHub e executar ações automaticamente com base neles. Confira Usando webhooks com aplicativos GitHub.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Em "Webhook", para habilitar ou desabilitar o webhook, selecione ou desmarque Ativo.
3. Se você selecionou Ativo na etapa anterior, em "URL do Webhook", insira a URL para a qual GitHub os eventos de webhook devem ser enviados.
4. Opcionalmente, se você selecionou Ativo na etapa anterior, em "Segredo do webhook", insira um token secreto para proteger seus webhooks. GitHub recomenda enfaticamente que você defina um segredo de webhook.

Alterando as assinaturas de eventos do webhook de um GitHub App

Você pode alterar os eventos de webhook aos quais um GitHub App assinante assina usando as etapas a seguir.

Os eventos de webhook específicos que você pode selecionar no registro do GitHub App são determinados pelo tipo de permissões selecionado para seu aplicativo. Primeiro, você precisará selecionar as permissões que deseja que seu aplicativo tenha e depois assinar o aplicativo em eventos de webhook relacionados a esse conjunto de permissões. Consulte Usando webhooks com aplicativos GitHub.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Ative o GitHub App webhook. Consulte Ativar ou desativar o GitHub App webhook neste artigo.
3. Na barra lateral de GitHub Apps configurações, clique em Permissões & eventos.
4. Nas seções "Permissões do repositório", "Permissões da organização" e "Permissões da conta", selecione as permissões necessárias para os eventos aos quais seu aplicativo se inscreverá. Consulte Como alterar as permissões de um GitHub App.
5. Em "Assinar eventos", selecione os eventos de webhook que você gostaria que seu GitHub App recebesse.
6. Selecione Salvar alterações.

Alterando a visibilidade de um GitHub App

Você pode alterar as configurações de visibilidade do seu GitHub App para controlar quem pode instalá-lo. Aplicativos públicos não podem se tornar privados se estiverem instalados em outras contas. Confira Tornando um aplicativo GitHub público ou privado.

Você não pode alterar a visibilidade de um(a) GitHub App pertencente a uma empresa. GitHub Apps de propriedade de uma empresa só pode ser instalado em organizações dentro da empresa ou na própria empresa.

1. Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira Navegar até as configurações do GitHub App neste artigo.
2. Na barra lateral esquerda, clique em Avançado.
3. Em "Zona de perigo", dependendo da visibilidade atual da sua GitHub App, clique em Tornar público ou Tornar privado.