Skip to main content

Esta versão do GitHub Enterprise será descontinuada em 2022-09-28. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Criar um aplicativo GitHub usando parâmetros de URL

Você pode pré-selecionar as configurações de um novo GitHub App usando a URL parâmetros de consulta para definir rapidamente a configuração do novo GitHub App.

Sobre parâmetros de URL do GitHub App.

Você pode adicionar parâmetros de consulta a essas URLs para pré-selecionar a configuração de um GitHub App em uma conta pessoal ou de organização:

  • Conta pessoal: http(s)://[hostname]/settings/apps/new
  • Conta da organização: http(s)://[hostname]/organizations/:org/settings/apps/new

A pessoa que está criando o aplicativo pode editar os valores pré-selecionados a partir da página de registro do GitHub App, antes de enviar o aplicativo. Se você não incluir os parâmetros obrigatórios na cadeia de consulta da URL, como name, a pessoa que criar o aplicativo precisará inserir um valor antes de enviar o aplicativo.

Para aplicativos que exigem que um segredo proteja seu webhook, o valor do segredo deve ser definido no formulário pela pessoa que criou o aplicativo, não pelo uso de parâmetros de consulta. Para obter mais informações, confira "Como proteger seus webhooks".

A URL a seguir cria um aplicativo público chamado octocat-github-app com uma descrição pré-configurada e uma URL de retorno de chamada. Essa URL também seleciona as permissões de leitura e gravação para checks, inscreve-se nos eventos de webhook check_run e check_suite e seleciona a opção para solicitar a autorização do usuário (OAuth) durante a instalação:

http(s)://[hostname]/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_urls[]=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite

Lista completa de parâmetros de consulta, permissões e eventos disponíveis encontra-se nas seções abaixo.

Parâmetros de configuração do GitHub App

NomeTipoDescrição
namestringO nome do GitHub App. Dê um nome claro e sucinto ao seu aplicativo. Seu aplicativo não pode ter o mesmo nome de um usuário existente no GitHub, a menos que seja o seu próprio nome de usuário ou da sua organização. Uma versão movida do nome do seu aplicativo será exibida na interface do usuário quando sua integração realizar uma ação.
descriptionstringUma descrição do GitHub App.
urlstringA URL completa da página inicial do site do seu GitHub App.
callback_urlsarray of stringsUma URL completa para a qual redirecionar após alguém autorizar uma instalação. Você pode fornecer até 10 URLs de retorno de chamada. Essas URLs são usadas se o aplicativo precisar identificar e autorizar solicitações de usuário para servidor. Por exemplo, callback_urls[]=https://example.com&callback_urls[]=https://example-2.com.
request_oauth_on_installbooleanSe o seu aplicativo autorizar usuários a usar o fluxo do OAuth, defina essa opção como true para permitir que pessoas autorizem o aplicativo ao instalá-lo, poupando uma etapa. Se você selecionar essa opção, a setup_url não ficará disponível e os usuários serão redirecionados para a callback_url após a instalação do aplicativo.
setup_urlstringA URL completa para redirecionamento após alguém instalar o GitHub App, se o aplicativo precisar de configuração adicional após a instalação.
setup_on_updatebooleanDefina como true para redirecionar as pessoas para a URL de configuração quando as instalações forem atualizadas, por exemplo, depois que os repositórios forem adicionados ou removidos.
publicbooleanDefina essa opção como true quando o GitHub App estiver disponível para o público ou como false quando ele só for acessível pelo proprietário do aplicativo.
webhook_activebooleanDefina-a como false para desabilitar o webhook. O webhook está habilitado por padrão.
webhook_urlstringA URL completa para a qual você deseja enviar as cargas do evento de webhook.
eventsarray of stringsEventos de webhook. Alguns eventos de webhook exigem permissões de read ou de write em um recurso para que você selecione o evento ao registrar um novo GitHub App. Confira a seção "Eventos de webhook do GitHub App" para ver os eventos disponíveis e as permissões necessárias. Você pode selecionar vários eventos em uma string de consulta. Por exemplo, events[]=public&events[]=label.
domainstringA URL de uma referência de conteúdo.
single_file_namestringEsta é uma permissão de escopo limitado que permite que o aplicativo acesse um único arquivo em qualquer repositório. Quando você define a permissão single_file como read ou write, esse campo fornece o caminho para o único arquivo que será gerenciado pelo GitHub App. Caso você precise gerenciar vários arquivos, confira single_file_paths abaixo.
single_file_pathsarray of stringsIsso permite que o aplicativo acesse até dez arquivos especificados em um repositório. Quando você define a permissão single_file como read ou write, essa matriz pode armazenar os caminhos para até dez arquivos que serão gerenciados pelo GitHub App. Todos esses arquivos recebem a mesma permissão definida por single_file e não têm permissões individuais separadas. Quando dois ou mais arquivos são configurados, a API retorna multiple_single_files=true, caso contrário, retorna multiple_single_files=false.

Permissões do GitHub App

Você pode selecionar permissões em uma string de consultas usando o nome da permissão na tabela a seguir como o nome do parâmetro de consulta e o tipo de permissão como valor da consulta. Por exemplo, para selecionar as permissões Read & write na interface do usuário de contents, a cadeia de consulta incluirá &contents=write. Para selecionar as permissões Read-only na interface do usuário de blocking, a cadeia de consulta incluirá &blocking=read. Para selecionar no-access na interface do usuário de checks, a cadeia de consulta não incluirá a permissão checks.

PermissãoDescrição
administrationConcede acesso a vários pontos finais para administração de organização e repositório. Pode ser: none, read ou write.
checksPermite o acesso à API de Verificações. Pode ser: none, read ou write.
content_referencesPermite o acesso ao ponto de extremidade "Criar um anexo de conteúdo". Pode ser: none, read ou write.
contentsConcede acesso a vários pontos finais que permitem modificar o conteúdo do repositório. Pode ser: none, read ou write.
deploymentsPermite o acesso à API de Implantações. Pode ser: none, read ou write.
emailsPermite o acesso à API de Emails. Pode ser: none, read ou write.
followersPermite o acesso à API de Seguidores. Pode ser: none, read ou write.
gpg_keysPermite o acesso à API de Chaves GPG. Pode ser: none, read ou write.
issuesPermite o acesso à API de Problemas. Pode ser: none, read ou write.
keysPermite o acesso à API de Chaves Públicas. Pode ser: none, read ou write.
membersConcede acesso para gerenciar os membros de uma organização. Pode ser: none, read ou write.
organization_hooksPermite o acesso à API de Webhooks da Organização. Pode ser: none, read ou write.
organization_planPermite o acesso para obter informações sobre o plano de uma organização usando o ponto de extremidade "Obter uma organização". Pode ser: none ou read.
organization_projectsPermite o acesso à API de Projetos. Pode ser: none, read, write ou admin.
pagesPermite o acesso à API do Pages. Pode ser: none, read ou write.
planPermite o acesso para obter informações sobre o plano do GitHub de um usuário usando o ponto de extremidade "Obter um usuário". Pode ser: none ou read.
pull_requestsConcede acesso a vários pontos finais do pull request. Pode ser: none, read ou write.
repository_hooksPermite o acesso à API de Webhooks do Repositório. Pode ser: none, read ou write.
repository_projectsPermite o acesso à API de Projetos. Pode ser: none, read, write ou admin.
secret_scanning_alertsPermite o acesso à API de verificação de segredos. Pode ser: none, read ou write.
security_eventsPermite o acesso à API de verificação de código. Pode ser: none, read ou write.
single_filePermite o acesso à API de Conteúdo. Pode ser: none, read ou write.
starringPermite o acesso à API de Marcação com Estrelas. Pode ser: none, read ou write.
statusesPermite o acesso à API de Status. Pode ser: none, read ou write.
team_discussionsPermite o acesso à API de Discussões em Equipe e à API de Comentários de Discussão em Equipe. Pode ser none, read ou write.
vulnerability_alertsPermite acesso para receber Dependabot alerts em um repositório. Confira "Sobre os Dependabot alerts" para saber mais. Pode ser: none ou read.
watchingConcede acesso à lista e alterações de repositórios que um usuário assinou. Pode ser: none, read ou write.

Eventos webhook do GitHub App

Nome do evento webhookPermissão necessáriaDescrição
check_runchecksVerifique se a atividade de execução ocorreu. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "execuções de verificação".
check_suitechecksOcorreu uma atividade de conjuntos de verificações. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "pacotes de verificação".
commit_commentcontentsUm comentário de commit foi criado. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "comentário sobre commits".
content_referencecontent_referencesUma nova referência de conteúdo é created. Uma nova referência de conteúdo é criada quando o texto ou comentário de um problema ou pull request inclui uma URL que corresponde a um domínio de referência de conteúdo configurado. Para obter mais informações, confira "Como usar anexos de conteúdo" para saber mais sobre referências de conteúdo e anexos.
createcontentsUm branch ou tag do Git é criado. Para obter mais informações, confira a API REST do "Banco de Dados do Git".
deletecontentsUm branch ou tag do Git é excluído. Para obter mais informações, confira a API REST do "Banco de Dados do Git".
deploymentdeploymentsUma implantação foi criada. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "implantação".
deployment_statusdeploymentsUma implantação foi criada. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "implantações".
forkcontentsUm usuário bifurca um repositório. Para obter mais informações, confira a REST API de "forks".
gollumcontentsUma página wiki foi criada ou atualizada. Para obter mais informações, confira "Sobre os wikis".
issuesissuesAtividade relacionada a um problema. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "problemas".
issue_commentissuesAtividade relacionada a um comentário sobre um problema ou sobre uma solicitação de pull. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "comentários sobre problemas".
labelmetadataAtividade relacionada a um rótulo. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "rótulos".
membermembersAtividade relacionada aos colaboradores do repositório. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "colaboradores".
membershipmembersAtividade relacionada à associação na equipe. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "membros da equipe".
milestonepull_requestAtividade relacionada aos marcos. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "marcos".
organizationmembersAtividade relacionada a uma organização e seus integrantes. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "organizações".
page_buildpagesRepresenta uma tentativa de criação de um site do GitHub Pages, independentemente de êxito. Um push para um branch habilitado para o GitHub Pages (gh-pages para páginas de projeto, o branch padrão para páginas de usuário e de organização) dispara esse evento.
projectrepository_projects ou organization_projectsAtividade relacionada a project boards. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "projetos".
project_cardrepository_projects ou organization_projectsAtividade relacionada a cartões em um project board. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "quadros de projetos".
project_columnrepository_projects ou organization_projectsAtividade relacionada a colunas em um project board. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "colunas do projeto".
publicmetadataQuando um repositório privado torna-se público. Sem dúvida: o melhor evento de GitHub Enterprise Server.
pull_requestpull_requestsAtividade relacionada a pull requests. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "solicitações de pull".
pull_request_reviewpull_requestAtividade relacionada a revisões de pull request. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "revisões de solicitação de pull".
pull_request_review_commentpull_requestAtividade relacionada aos comentários de revisão do pull request no diff unificado do pull request. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "comentários de revisão de solicitações de pull".
pull_request_review_threadpull_requestAtividade relacionada a um thread de comentários em uma solicitação de pull que está sendo marcada como resolvida ou não resolvida. O tipo de atividade é especificado na propriedade action do objeto de conteúdo.
pushcontentsUm ou mais commits são enviados para uma branch ou tag de um repositório.
releasecontentsAtividade relacionada a uma versão. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "versões".
repositorymetadataAtividade relacionada a um repositório. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "repositórios".
statusstatusesQuando o status de um commit do Git é alterado. Para obter mais informações, confira a REST API de "status".
teammembersAtividade relacionada à equipe de uma organização. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "equipes".
team_addmembersQuando um repositório é adicionado a uma equipe.
watchmetadataQuando alguém marca um repositório com uma estrela. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "marcação com estrelas".