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 de usuário:
https://github.com/settings/apps/new - Conta de organização:
https://github.com/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:
https://github.com/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_url=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_url | string | A URL completa para onde redirecionar após alguém autorizar uma instalação. Esta URL é usada se o aplicativo precisar identificar e autorizar solicitações de usuário para servidor. |
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_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. |
eventos | 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 | Ao conceder acesso de leitura ou gravação à permissão single_file, este campo fornecerá o caminho o para o único arquivo que seu aplicativo GitHub irá gerenciar. |
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, leutra, gravação ou administrador. |
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 | Concede acesso a alertas de segurança para dependências vulneráveis em um repositório. Consulte "Sobre alertas de segurança para dependências vulneráveis" para saber mais. Pode ser: nenhum ou leitura. |
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 | Check run activity has occurred. The type of activity is specified in the action property of the payload object. For more information, see the "check runs" REST API. |
check_suite | Verificações | Check suite activity has occurred. The type of activity is specified in the action property of the payload object. For more information, see the "check suites" REST API. |
commit_comment | Conteúdo | A commit comment is created. The type of activity is specified in the action property of the payload object. For more information, see the "commit comment" REST API. |
content_reference | content_references | A new content reference is created. A new content reference is created when the body or comment of an issue or pull request includes a URL that matches a configured content reference domain. For more information, see "Using content attachments" to learn more about content references and attachments. |
create | Conteúdo | A Git branch or tag is created. For more information, see the "Git data" REST API. |
delete | Conteúdo | A Git branch or tag is deleted. For more information, see the "Git data" REST API. |
implantação | Implantações | A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment" REST API. |
implantação_status | Implantações | A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment statuses" REST API. |
bifurcação | Conteúdo | A user forks a repository. For more information, see the "forks" REST API. |
gollum | Conteúdo | A wiki page is created or updated. For more information, see the "About wikis". |
Problemas | Problemas | Activity related to an issue. The type of activity is specified in the action property of the payload object. For more information, see the "issues" REST API. |
issue_comment | Problemas | Activity related to an issue comment. The type of activity is specified in the action property of the payload object. For more information, see the "issue comments" REST API. |
etiqueta | metadados | Activity related to an issue. The type of activity is specified in the action property of the payload object. For more information, see the "labels" REST API. |
integrante | members | Activity related to repository collaborators. The type of activity is specified in the action property of the payload object. For more information, see the "collaborators" REST API. |
filiação | members | Activity related to team membership. The type of activity is specified in the action property of the payload object. For more information, see the "team members" REST API. |
marco | pull_request | Activity related to milestones. The type of activity is specified in the action property of the payload object. For more information, see the "milestones" REST API. |
organization | members | Activity related to an organization and its members. The type of activity is specified in the action property of the payload object. For more information, see the "organizations" REST API. |
page_build | Páginas | Represents an attempted build of a GitHub Pages site, whether successful or not. A push to a GitHub Pages enabled branch (gh-pages for project pages, master for user and organization pages) triggers this event. |
project | repository_projects ou organization_projects | Activity related to project boards. The type of activity is specified in the action property of the payload object. For more information, see the "projects" REST API. |
project_card | repository_projects ou organization_projects | Activity related to project cards. The type of activity is specified in the action property of the payload object. For more information, see the "project cards" REST API. |
project_column | repository_projects ou organization_projects | Activity related to columns in a project board. The type of activity is specified in the action property of the payload object. For more information, see the "project columns" REST API. |
público | metadados | When a private repository is made public. Without a doubt: the best GitHub Enterprise event. |
pull_request | pull_requests | Activity related to pull requests. The type of activity is specified in the action property of the payload object. For more information, see the "pull requests" REST API. |
pull_request_review | pull_request | Activity related to pull request reviews. The type of activity is specified in the action property of the payload object. For more information, see the "pull request reviews" REST API. |
pull_request_review_comment | pull_request | Activity related to pull request review comments in the pull request's unified diff. The type of activity is specified in the action property of the payload object. For more information, see the "pull request review comments" REST API. |
push | Conteúdo | One or more commits are pushed to a repository branch or tag. |
versão | Conteúdo | Activity related to a release. The type of activity is specified in the action property of the payload object. For more information, see the "releases" REST API. |
repositório | metadados | Activity related to a repository. The type of activity is specified in the action property of the payload object. For more information, see the "repositories" REST API. |
status | Status | When the status of a Git commit changes. The type of activity is specified in the action property of the payload object. For more information, see the "statuses" REST API. |
equipe | members | Activity related to an organization's team. The type of activity is specified in the action property of the payload object. For more information, see the "teams" REST API. |
team_add | members | When a repository is added to a team. |
inspecionar | metadados | When someone stars a repository. The type of activity is specified in the action property of the payload object. For more information, see the "starring" REST API. |