Permissions required for GitHub Apps

You can find the required permissions for each aplicativo GitHub-compatible endpoint.

About aplicativo GitHub permissions

Aplicativos do GitHub are created with a set of permissions. Permissions define what resources the aplicativo GitHub can access via the API. For more information, see "Setting permissions for GitHub Apps."

Metadata permissions

GitHub Apps have the Read-only metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information.

Se você definir a permissão de metadados para No access e selecionar uma permissão que exija acesso ao repositório, GitHub irá substituir sua seleção e definir a permissão de metadados de volta para Read-only. Para definir a permissão de metadados para No access, você deve definir todas as permissões que requerem acesso ao repositório No access primeiro.

Collaborators

Commit comments

Events

Git

Keys

Organization members

Search

Permission on "actions"

Permission on "administration"

Branches

Collaborators

Invitations

Keys

Teams

Permission on "checks"

Permission on "contents"

Branches

Commit comments

Git

Reactions

Releases

Permission on "deployments"

Permission on "emails"

Permission on "followers"

Permission on "gpg keys"

Permission on "issues"

Issues and pull requests are closely related. For more information, see "List issues assigned to the authenticated user." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues.

Assignees

Events

Labels

Milestones

Reactions

Permission on "keys"

Keys

Permission on "members"

Organization members

Team members

Teams

Permission on "organization administration"

Permission on "organization events"

Permission on "organization hooks"

Teams

Permission on "organization pre receive hooks"

Permission on "organization projects"

Permission on "pages"

Permission on "pull requests"

Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests.

Assignees

Events

Labels

Milestones

Reactions

Requested reviewers

Reviews

Permission on "profile"

Permission on "repository hooks"

Permission on "repository pre receive hooks"

Permission on "repository projects"

Teams

Permission on "secret scanning alerts"

Permission on "security events"

Permission on "self-hosted runners"

Permission on "single file"

Permission on "starring"

Permission on "statuses"

Permission on "team discussions"

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.