Sobre parâmetros de URL do aplicativo GitHub.
Você pode adicionar parâmetros de consulta a essas URLs para pré-selecionar a configuração de um aplicativo GitHub 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 aplicativo GitHub, antes de enviar o aplicativo. Se você não incluir os parâmetros necessários na string de consulta da URL, como, por exemplo, o nome, a pessoa que criar o aplicativo deverá inserir um valor antes de enviar o aplicativo.
A URL a seguir cria um novo aplicativo pública denominado octocat-github-app com uma descrição pré-configurada e URL de chamada de retorno. Esta URL também seleciona permissões de leitura e gravação para verificações, inscreve-se nos eventos webhook de check_run e <code>check_suite e seleciona a opção de solicitar 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 aplicativo GitHub
| Nome | Tipo | Descrição |
|---|---|---|
name | string | O nome do aplicativo GitHub. 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. |
descrição | string | Uma descrição do aplicativo GitHub. |
url | string | A URL completa da página inicial do site do seu aplicativo GitHub. |
callback_urls | array de strigns | Uma 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_install | boolean | Se seu aplicativo autoriza usuários a usar o fluxo OAuth, você poderá definir essa opção como verdadeiro para permitir que pessoas autorizem o aplicativo ao instalá-lo, economizando um passo. Se você selecionar esta opção, setup_url irá tornar-se indisponível e os usuários serão redirecionados para sua callback_url após instalar o aplicativo. |
setup_url | string | A URL completa para redirecionamento após alguém instalar o aplicativo GitHub, se o aplicativo precisar de configuração adicional após a instalação. |
setup_on_update | boolean | Defina como verdadeiro para redirecionar as pessoas para a URL de configuração quando as instalações forem atualizadas, por exemplo, após os repositórios serem adicionados ou removidos. |
público | boolean | Defina verdadeiro quando seu aplicativo GitHub estiver disponível para o público ou como falso quando só for acessível pelo proprietário do aplicativo. |
webhook_active | boolean | Defina como falso para desabilitar o webhook. O webhook está habilitado por padrão. |
webhook_url | string | A URL completa para a qual você deseja enviar as cargas do evento de webhook. |
webhook_secret | string | Você pode especificar um segredo para proteger seus webhooks. Consulte "Protegendo seus webhooks" para obter mais detalhes. |
events | array de strigns | Eventos webhook. Alguns eventos de webhook exigem permissões de leitura ou gravação para um recurso antes de poder selecionar o evento ao registrar um novo aplicativo GitHub, . Consulte a seção "aplicativo GitHub eventos de webhook" para eventos disponíveis e suas permissões necessárias. Você pode selecionar vários eventos em uma string de consulta. Por exemplo, eventos[]=public&eventos[]=label. |
domínio | string | A URL de uma referência de conteúdo. |
single_file_name | string | Esta é 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 para read ou write, este campo fornece o caminho para o único arquivo que o aplicativo GitHub gerenciará. Se você precisar gerenciar vários arquivos, veja single_file_paths abaixo. |
single_file_paths | array de strigns | Isso permite que o aplicativo acesse até dez arquivos especificados em um repositório. Quando você define a permissão single_file para read ou write, este array pode armazenar os caminhos de até dez arquivos que seu aplicativo GitHub gerenciará. 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 estão configurados, a API retorna multiple_single_files=true, caso contrário retorna multiple_single_files=false. |
Permissões do aplicativo GitHub
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 permissões de Leitura & gravação na interface de usuário para conteúdo, sua string de consulta incluiria &contents=write. Para selecionar as permissões Somente leitura na interface de usuário para bloquear, sua string de consulta incluiria &blocking=read. Para selecionar sem acesso na interface do usuário para verificações, sua string de consulta não incluiria a permissão verificações.
| Permissão | Descrição |
|---|---|
administração | Concede acesso a vários pontos finais para administração de organização e repositório. Pode ser: nenhum, leitura ou gravação. |
Verificações | Concede acesso � API de verificação. Pode ser: nenhum, leitura ou gravação. |
content_references | Concede acesso ao ponto final "Criar um anexo de conteúdo. Pode ser: nenhum, leitura ou gravação. |
Conteúdo | Concede acesso a vários pontos finais que permitem modificar o conteúdo do repositório. Pode ser: nenhum, leitura ou gravação. |
Implantações | Concede acesso � API de implementação. Pode ser: nenhum, leitura ou gravação. |
emails | Concede acesso � API de e-mails. Pode ser: nenhum, leitura ou gravação. |
seguidores | Concede acesso � API de seguidores. Pode ser: nenhum, leitura ou gravação. |
gpg_keys | Concede acesso � API de chaves de GPG. Pode ser: nenhum, leitura ou gravação. |
Problemas | Concede acesso � API de problemas. Pode ser: nenhum, leitura ou gravação. |
chaves | Concede acesso � API de chaves públicas. Pode ser: nenhum, leitura ou gravação. |
members | Concede acesso para gerenciar os membros de uma organização. Pode ser: nenhum, leitura ou gravação. |
organization_hooks | Concede acesso � API de webhooks da organização. Pode ser: nenhum, leitura ou gravação. |
organization_plan | Concede acesso para obter informações sobre o plano de uma organização usando o ponto final "Obter uma organização". Pode ser: nenhum ou leitura. |
organization_projects | Concede acesso � API de Projetos. Pode ser: nenhum, leitura, gravação ou administrador. |
Páginas | Concede acesso � API de páginas. Pode ser: nenhum, leitura ou gravação. |
plano | Concede acesso para obter informações sobre o plano de um usuário do GitHub que usa o ponto final "Obter um usuário". Pode ser: nenhum ou leitura. |
pull_requests | Concede acesso a vários pontos finais do pull request. Pode ser: nenhum, leitura ou gravação. |
repository_hooks | Concede acesso � API de webhooks do repositório. Pode ser: nenhum, leitura ou gravação. |
repository_projects | Concede acesso � API de Projetos. Pode ser: nenhum, leitura, gravação ou administrador. |
secret_scanning_alerts | Concede acesso � API de varredura de segredo. Pode ser: none, read ou write. |
security_events | Concede acesso � API de varredura de código. Pode ser: nenhum, leitura ou gravação. |
single_file | Concede acesso � API de conteúdo. Pode ser: nenhum, leitura ou gravação. |
estrela | Concede acesso � API estrelada. Pode ser: nenhum, leitura ou gravação. |
Status | Concede acesso � API de status. Pode ser: nenhum, leitura ou gravação. |
team_discussions | Concede acesso � API de discussões de equipe e � API de comentários de discussão de equipe. Pode ser: nenhum, leitura ou gravação. |
vulnerability_alerts | Grants access to receive Alertas do Dependabot in a repository. Consulte "Sobre Alertas do Dependabot" para saber mais. Pode ser: none ou read. |
inspecionando | Concede acesso � lista e alterações de repositórios que um usuário assinou. Pode ser: nenhum, leitura ou gravação. |
Eventos webhook do aplicativo GitHub
| Nome do evento webhook | Permissão necessária | Descrição |
|---|---|---|
check_run | Verificações | Verifique se a atividade de execução ocorreu. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "execuções de verificação". |
check_suite | Verificações | Ocorreu uma atividade de conjuntos de verificações. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de"conjunto de verificações". |
commit_comment | Conteúdo | Um comentário de commit foi criado. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "comentário de commit". |
content_reference | content_references | Uma nova referência de conteúdo foi criada. 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, consulte "Usar anexos de conteúdo" para saber mais sobre referências de conteúdo e anexos. |
create | Conteúdo | Um branch ou tag do Git é criado. For more information, see the "Git database" REST API. |
delete | Conteúdo | Um branch ou tag do Git é excluído. For more information, see the "Git database" REST API. |
implantação | Implantações | Uma implantação foi criada. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST "implantação". |
implantação_status | Implantações | Uma implantação foi criada. O tipo de atividade é especificado na propriedade ação do objeto da carga. For more information, see the "deployments" REST API. |
bifurcação | Conteúdo | Um usuário bifurca um repositório. Para obter mais informações, consulte a API REST de bifurcações". |
gollum | Conteúdo | Uma página wiki foi criada ou atualizada. Para obter mais informações, consulte "Sobre wikis." |
Problemas | Problemas | Atividade relacionada a um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST de problemas". |
issue_comment | Problemas | Activity related to an issue or pull request comment. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "comentários de problema". |
etiqueta | metadados | Activity related to a label. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte API REST de etiquetas". |
integrante | members | Atividade relacionada aos colaboradores do repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST dos colaboradores". |
filiação | members | Atividade relacionada � associação na equipe. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos integrantes da equipe". |
marco | pull_request | Atividade relacionada aos marcos. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos marcos". |
organização | members | Atividade relacionada a uma organização e seus integrantes. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APRI REST de "organizações". |
page_build | Páginas | Representa uma tentativa de criação de um site do GitHub Pages, independentemente de êxito. Um push para um branch habilitado de GitHub Pages (gh-pages para páginas de projeto, o branch-padrão para páginas de usuário e organização) aciona este evento. |
project | repository_projects ou organization_projects | Atividade relacionada aos quadros de projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte A API REST dos "projetos". |
project_card | repository_projects ou organization_projects | Atividade relacionada aos cartões do projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos cartões de projeto". |
project_column | repository_projects ou organization_projects | Atividade relacionada a colunas em um quadro de projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST das "colunas do projeto". |
público | metadados | Quando um repositório privado torna-se público. Sem dúvida: o melhor evento de GitHub Enterprise Server. |
pull_request | pull_requests | Atividade relacionada a pull requests. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "pull requests". |
pull_request_review | pull_request | Atividade relacionada a revisões de pull request. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST "Revisões de pull request". |
pull_request_review_comment | pull_request | Atividade relacionada aos comentários de revisão do pull request no diff unificado do pull request. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos "comentários de revisão de pull request". |
pull_request_review_thread | pull_request | Activity related to a comment thread on a pull request being marked as resolved or unresolved. O tipo de atividade é especificado na propriedade ação do objeto da carga. |
push | Conteúdo | Um ou mais commits são enviados para uma branch ou tag de um repositório. |
versão | Conteúdo | Atividade relacionada a uma versão. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST das versões". |
repositório | metadados | Atividade relacionada a um repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dosrepositórios". |
status | Status | Quando o status de um commit do Git é alterado. For more information, see the "statuses" REST API. |
equipe | members | Atividade relacionada � equipe de uma organização. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "equipes". |
team_add | members | Quando um repositório é adicionado a uma equipe. |
inspecionar | metadados | Quando alguém marca um repositório com uma estrela. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "marcar com uma estrela". |