Autorizando aplicativos GitHub

É possível autorizar um GitHub App a recuperar informações sobre sua conta do GitHub e fazer alterações em seu nome.

Neste artigo

Sobre a autorização para GitHub Apps

Aplicativos de terceiros que precisam verificar sua identidade do GitHub ou interagir com o GitHub em seu nome podem solicitar que você autorize um GitHub App a fazer isso. Se um aplicativo de terceiros quiser que você autorize um GitHub App, o aplicativo levará você para uma página do GitHub que solicita que você autorize o aplicativo.

Ao autorizar o GitHub App, verifique se o proprietário do aplicativo é confiável e examine as informações que ele deseja acessar. Durante a autorização, será necessário conceder ao GitHub App a permissão para fazer o seguinte:

  • Verificar sua identidade do GitHub: quando autorizado, o GitHub App poderá recuperar seu perfil público do GitHub. O aplicativo também pode recuperar algumas informações de conta particulares. Durante o processo de autorização, o GitHub informará a você quais informações de conta o GitHub App poderá acessar.
  • Saber quais recursos é possível acessar: quando autorizado, o GitHub App poderá determinar os recursos aos quais você tem acesso que o aplicativo também pode acessar. O aplicativo pode usar isso, por exemplo, para mostrar uma lista apropriada de repositórios.
  • Tomar ações em seu nome: quando autorizado, o aplicativo pode executar tarefas no GitHub em seu nome. Isso pode incluir a criação de um problema ou comentários em uma solicitação de pull. Para obter mais informações, confira "Sobre GitHub Apps agindo em seu nome".

É possível examinar e revogar sua autorização a qualquer momento. Para obter mais informações, confira "Revisar e revogar a autorização dos Aplicativos GitHub".

Observação: se a organização usa o SSO do SAML e você não consegue ver os recursos dela depois de autorizar um GitHub App, pode ser necessário reautorizar o aplicativo depois de iniciar uma sessão SAML ativa para a organização. Para obter mais informações, confira "SAML e aplicativos GitHub".

Sobre GitHub Apps agindo em seu nome

Depois de autorizar um GitHub App, o aplicativo pode realizar tarefas em seu nome. As situações nas quais um GitHub App atua em seu nome variam de acordo com o propósito do GitHub App e o contexto em que ele está sendo usado. Por exemplo, um IDE (ambiente de desenvolvimento integrado) pode usar um GitHub App para interagir em seu nome e enviar as alterações que você criou por meio dele de volta para os repositórios no GitHub.

O GitHub App só pode fazer coisas que você e o aplicativo têm permissão para fazer. Por exemplo, se você tiver acesso de gravação a um repositório, mas o GitHub App tiver somente acesso de leitura, o aplicativo só poderá ler o conteúdo do repositório, mesmo quando estiver realizando tarefas em seu nome. Da mesma forma, se você tiver acesso aos repositórios A e B e o GitHub App tiver acesso aos repositórios B e C, o aplicativo só poderá acessar o repositório B ao realizar tarefas em seu nome. Para obter mais informações sobre as permissões concedidas a um GitHub App, confira "Diferença entre autorização e instalação".

Quando um aplicativo realiza tarefas em seu nome, ele atribui a atividade a você e a ele. Por exemplo, se o aplicativo postar um comentário em seu nome, a interface do usuário do GitHub mostrará a foto de seu avatar e o crachá de identidade do aplicativo como o autor do problema.

Captura de tela de um comentário que tem um avatar de usuário com um selo identicon do aplicativo sobreposto. O avatar é realçado com um contorno laranja.

Da mesma forma, se a atividade disparar uma entrada correspondente nos logs de auditoria e nos logs de segurança, eles listarão você como o ator, mas informarão que o "programmatic_access_type" é "token de usuário para servidor do Aplicativo do GitHub".

Diferença entre a autorização e a instalação

Ao instalar um GitHub App em sua conta ou organização, você concede ao aplicativo permissão para acessar os recursos de organização e repositório solicitados. Você também especifica quais repositórios o aplicativo pode acessar. Durante o processo de instalação, o GitHub App indicará quais permissões de repositório e organização você está concedendo. Para obter mais informações sobre quais permissões diferentes permitem que um GitHub App faça, consulte "Escolhendo permissões para um Aplicativo GitHub".

Por exemplo, você pode conceder ao GitHub App permissão para gravar problemas e ler metadados do repositório e conceder ao GitHub App acesso a todos os repositórios.

Captura de tela da página para instalar um Aplicativo GitHub. O aplicativo está solicitando acesso de leitura a metadados e acesso de gravação a problemas. O aplicativo também pode solicitar autorização do usuário para acesso de leitura a emails e acesso de gravação aos gists.

Ao autorizar um GitHub App, você concede a ele acesso à sua conta do GitHub, com base nas permissões de conta solicitadas. Durante o processo de autorização, o aplicativo indicará quais recursos o aplicativo pode acessar em sua conta. Ao autorizar um GitHub App, você também concede ao aplicativo permissão para agir em seu nome.

Por exemplo, você pode conceder ao GitHub App permissão para ler seus endereços de email e gravar gists.

Captura de tela da página para autorizar um Aplicativo GitHub. O aplicativo está solicitando acesso de leitura a email e acesso de gravação a gists.

É possível instalar um GitHub App sem autorizar o aplicativo. Da mesma forma, é possível autorizar o aplicativo sem instalá-lo.

Para saber mais sobre a instalação, confira "Instalando um Aplicativo GitHub de terceiros," "Instalando um Aplicativo GitHub por meio do GitHub Marketplace em sua conta pessoal" e "Instalando um Aplicativo GitHub por meio do GitHub Marketplace em suas organizações."