Sobre as permissões de GitHub App
GitHub Apps são criadas com um conjunto de permissões. As permissões definem quais recursos o GitHub App pode acessar através da API. Para obter mais informações, confira "Escolhendo permissões para um Aplicativo GitHub".
Para ajudar você a escolher as permissões corretas, você receberá o cabeçalho X-Accepted-GitHub-Permissions
na resposta da API REST. O cabeçalho informará quais permissões são necessárias para acessar o ponto de extremidade. Para obter mais informações, confira "Solucionar problemas do API REST".
Essas permissões são necessárias para acessar recursos privados com os seguintes pontos de extremidade. Alguns pontos de extremidade também podem ser usados para acessar recursos públicos sem essas permissões.
Alguns pontos de extremidade exigem permissões adicionais. Quando isso ocorrer, a coluna "Permissões adicionais" indicará as outras permissões necessárias para usar o ponto de extremidade.
Organization permissions for "Administration"
Organization permissions for "Blocking users"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PUT /orgs/{org}/blocks/{username} | write | UAT IAT | ✖️ |
DELETE /orgs/{org}/blocks/{username} | write | UAT IAT | ✖️ |
GET /orgs/{org}/blocks | read | UAT IAT | ✖️ |
GET /orgs/{org}/blocks/{username} | read | UAT IAT | ✖️ |
Organization permissions for "Custom organization roles"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /orgs/{org}/organization-roles | write | UAT IAT | ✖️ |
PATCH /orgs/{org}/organization-roles/{role_id} | write | UAT IAT | ✖️ |
DELETE /orgs/{org}/organization-roles/{role_id} | write | UAT IAT | ✖️ |
GET /orgs/{org}/organization-fine-grained-permissions | read | UAT IAT | ✖️ |
GET /orgs/{org}/organization-roles | read | UAT IAT | ✖️ |
GET /orgs/{org}/organization-roles/{role_id} | read | UAT IAT | ✖️ |
Organization permissions for "Custom properties"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PATCH /orgs/{org}/properties/schema | admin | UAT IAT | ✖️ |
PUT /orgs/{org}/properties/schema/{custom_property_name} | admin | UAT IAT | ✖️ |
DELETE /orgs/{org}/properties/schema/{custom_property_name} | admin | UAT IAT | ✖️ |
PATCH /orgs/{org}/properties/values | write | UAT IAT | ✖️ |
GET /orgs/{org}/properties/schema | read | UAT IAT | ✖️ |
GET /orgs/{org}/properties/schema/{custom_property_name} | read | UAT IAT | ✖️ |
GET /orgs/{org}/properties/values | read | UAT IAT | ✖️ |
Organization permissions for "Events"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
GET /users/{username}/events/orgs/{org} | read | UAT | ✖️ |
Organization permissions for "GitHub Copilot Business"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
GET /orgs/{org}/copilot/billing | write | UAT IAT | ✖️ |
GET /orgs/{org}/copilot/billing/seats | write | UAT IAT | ✖️ |
POST /orgs/{org}/copilot/billing/selected_teams | write | UAT IAT | ✖️ |
Organization permissions for "Members"
Organization permissions for "Organization codespaces secrets"
Organization permissions for "Organization codespaces settings"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PUT /orgs/{org}/codespaces/access | write | UAT IAT | ✖️ |
POST /orgs/{org}/codespaces/access/selected_users | write | UAT IAT | ✖️ |
DELETE /orgs/{org}/codespaces/access/selected_users | write | UAT IAT | ✖️ |
Organization permissions for "Organization codespaces"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name} | write | UAT IAT | |
POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop | write | UAT IAT | |
GET /orgs/{org}/codespaces | read | UAT IAT | |
GET /orgs/{org}/members/{username}/codespaces | read | UAT IAT |
Organization permissions for "Organization dependabot secrets"
Organization permissions for "Personal access token requests"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /orgs/{org}/personal-access-token-requests | write | UAT IAT | ✖️ |
POST /orgs/{org}/personal-access-token-requests/{pat_request_id} | write | UAT IAT | ✖️ |
GET /orgs/{org}/personal-access-token-requests | read | UAT IAT | ✖️ |
GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories | read | UAT IAT | ✖️ |
Organization permissions for "Personal access tokens"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /orgs/{org}/personal-access-tokens | write | UAT IAT | ✖️ |
POST /orgs/{org}/personal-access-tokens/{pat_id} | write | UAT IAT | ✖️ |
GET /orgs/{org}/personal-access-tokens | read | UAT IAT | ✖️ |
GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories | read | UAT IAT | ✖️ |
Organization permissions for "Projects"
Organization permissions for "Secrets"
Organization permissions for "Self-hosted runners"
Organization permissions for "Team discussions"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id} | write | UAT IAT | ✖️ |
DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id} | write | UAT IAT | ✖️ |
Organization permissions for "Variables"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /orgs/{org}/actions/variables | write | UAT IAT | ✖️ |
PATCH /orgs/{org}/actions/variables/{name} | write | UAT IAT | ✖️ |
DELETE /orgs/{org}/actions/variables/{name} | write | UAT IAT | ✖️ |
PUT /orgs/{org}/actions/variables/{name}/repositories | write | UAT IAT | ✖️ |
PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id} | write | UAT IAT | |
GET /orgs/{org}/actions/variables | read | UAT IAT | ✖️ |
GET /orgs/{org}/actions/variables/{name} | read | UAT IAT | ✖️ |
GET /orgs/{org}/actions/variables/{name}/repositories | read | UAT IAT | ✖️ |
Organization permissions for "Webhooks"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /orgs/{org}/hooks | write | UAT IAT | ✖️ |
PATCH /orgs/{org}/hooks/{hook_id} | write | UAT IAT | ✖️ |
DELETE /orgs/{org}/hooks/{hook_id} | write | UAT IAT | ✖️ |
PATCH /orgs/{org}/hooks/{hook_id}/config | write | UAT IAT | ✖️ |
POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts | write | UAT IAT | ✖️ |
POST /orgs/{org}/hooks/{hook_id}/pings | write | UAT IAT | ✖️ |
GET /orgs/{org}/hooks | read | UAT IAT | ✖️ |
GET /orgs/{org}/hooks/{hook_id} | read | UAT IAT | ✖️ |
GET /orgs/{org}/hooks/{hook_id}/config | read | UAT IAT | ✖️ |
GET /orgs/{org}/hooks/{hook_id}/deliveries | read | UAT IAT | ✖️ |
GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id} | read | UAT IAT | ✖️ |
Repository permissions for "Actions"
Repository permissions for "Administration"
Repository permissions for "Checks"
Repository permissions for "Code scanning alerts"
Repository permissions for "Codespaces lifecycle admin"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop | write | UAT IAT | |
POST /user/codespaces/{codespace_name}/exports | write | UAT | ✖️ |
POST /user/codespaces/{codespace_name}/start | write | UAT | ✖️ |
POST /user/codespaces/{codespace_name}/stop | write | UAT | ✖️ |
GET /user/codespaces/{codespace_name}/exports/{export_id} | read | UAT | ✖️ |
Repository permissions for "Codespaces metadata"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
GET /repos/{owner}/{repo}/codespaces/devcontainers | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/codespaces/machines | read | UAT IAT | ✖️ |
GET /user/codespaces/{codespace_name}/machines | read | UAT | ✖️ |
Repository permissions for "Codespaces secrets"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
GET /repos/{owner}/{repo}/codespaces/secrets | write | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/codespaces/secrets/public-key | write | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name} | write | UAT IAT | ✖️ |
PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name} | write | UAT IAT | |
DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name} | write | UAT IAT |
Repository permissions for "Codespaces"
Repository permissions for "Commit statuses"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /repos/{owner}/{repo}/statuses/{sha} | write | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/commits/{ref}/status | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/commits/{ref}/statuses | read | UAT IAT | ✖️ |
Repository permissions for "Contents"
Repository permissions for "Dependabot alerts"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number} | write | UAT IAT | ✖️ |
GET /orgs/{org}/dependabot/alerts | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/dependabot/alerts | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number} | read | UAT IAT | ✖️ |
Repository permissions for "Dependabot secrets"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name} | write | UAT IAT | ✖️ |
DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name} | write | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/dependabot/secrets | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/dependabot/secrets/public-key | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name} | read | UAT IAT | ✖️ |
Repository permissions for "Deployments"
Repository permissions for "Environments"
Repository permissions for "Issues"
Repository permissions for "Metadata"
Repository permissions for "Pages"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /repos/{owner}/{repo}/pages | write | UAT IAT | |
PUT /repos/{owner}/{repo}/pages | write | UAT IAT | |
DELETE /repos/{owner}/{repo}/pages | write | UAT IAT | |
POST /repos/{owner}/{repo}/pages/builds | write | UAT IAT | ✖️ |
POST /repos/{owner}/{repo}/pages/deployment | write | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/pages/health | write | UAT IAT | |
GET /repos/{owner}/{repo}/pages | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/pages/builds | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/pages/builds/latest | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/pages/builds/{build_id} | read | UAT IAT | ✖️ |
Repository permissions for "Projects"
Repository permissions for "Pull requests"
Repository permissions for "Repository security advisories"
Repository permissions for "Secret scanning alerts"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number} | write | UAT IAT | ✖️ |
GET /orgs/{org}/secret-scanning/alerts | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/secret-scanning/alerts | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number} | read | UAT IAT | ✖️ |
GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations | read | UAT IAT | ✖️ |
Repository permissions for "Secrets"
Repository permissions for "Variables"
Repository permissions for "Webhooks"
Repository permissions for "Workflows"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /repos/{owner}/{repo}/git/refs | write | UAT IAT | |
PATCH /repos/{owner}/{repo}/git/refs/{ref} | write | UAT IAT | |
POST /repos/{owner}/{repo}/releases | write | UAT IAT |
User permissions for "Block another user"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PUT /user/blocks/{username} | write | UAT | ✖️ |
DELETE /user/blocks/{username} | write | UAT | ✖️ |
GET /user/blocks | read | UAT | ✖️ |
GET /user/blocks/{username} | read | UAT | ✖️ |
User permissions for "Codespaces user secrets"
User permissions for "Email addresses"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PATCH /user/email/visibility | write | UAT | ✖️ |
POST /user/emails | write | UAT | ✖️ |
DELETE /user/emails | write | UAT | ✖️ |
GET /user/emails | read | UAT | ✖️ |
GET /user/public_emails | read | UAT | ✖️ |
User permissions for "Followers"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PUT /user/following/{username} | write | UAT | ✖️ |
DELETE /user/following/{username} | write | UAT | ✖️ |
GET /user/followers | read | UAT | ✖️ |
GET /user/following | read | UAT | ✖️ |
GET /user/following/{username} | read | UAT | ✖️ |
User permissions for "GPG keys"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /user/gpg_keys | write | UAT | ✖️ |
DELETE /user/gpg_keys/{gpg_key_id} | write | UAT | ✖️ |
GET /user/gpg_keys | read | UAT | ✖️ |
GET /user/gpg_keys/{gpg_key_id} | read | UAT | ✖️ |
User permissions for "Gists"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /gists | write | UAT | |
PATCH /gists/{gist_id} | write | UAT | |
DELETE /gists/{gist_id} | write | UAT | |
POST /gists/{gist_id}/comments | write | UAT | |
PATCH /gists/{gist_id}/comments/{comment_id} | write | UAT | |
DELETE /gists/{gist_id}/comments/{comment_id} | write | UAT | |
POST /gists/{gist_id}/forks | write | UAT | |
PUT /gists/{gist_id}/star | write | UAT | |
DELETE /gists/{gist_id}/star | write | UAT |
User permissions for "Git SSH keys"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /user/keys | write | UAT | ✖️ |
DELETE /user/keys/{key_id} | write | UAT | ✖️ |
GET /user/keys | read | UAT | ✖️ |
GET /user/keys/{key_id} | read | UAT | ✖️ |
GET /users/{username}/keys | read | UAT IAT | ✖️ |
User permissions for "Interaction limits"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PUT /user/interaction-limits | write | UAT | ✖️ |
DELETE /user/interaction-limits | write | UAT | ✖️ |
GET /user/interaction-limits | read | UAT | ✖️ |
User permissions for "Notifications"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
GET /notifications | read | UAT |
User permissions for "Plan"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
GET /users/{username}/settings/billing/actions | read | UAT | ✖️ |
GET /users/{username}/settings/billing/packages | read | UAT | ✖️ |
GET /users/{username}/settings/billing/shared-storage | read | UAT | ✖️ |
User permissions for "Profile"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PATCH /user | write | UAT | ✖️ |
POST /user/social_accounts | write | UAT | ✖️ |
DELETE /user/social_accounts | write | UAT | ✖️ |
User permissions for "SSH signing keys"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
POST /user/ssh_signing_keys | write | UAT | ✖️ |
DELETE /user/ssh_signing_keys/{ssh_signing_key_id} | write | UAT | ✖️ |
GET /user/ssh_signing_keys | read | UAT | ✖️ |
GET /user/ssh_signing_keys/{ssh_signing_key_id} | read | UAT | ✖️ |
User permissions for "Starring"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
PUT /user/starred/{owner}/{repo} | write | UAT | ✖️ |
DELETE /user/starred/{owner}/{repo} | write | UAT | ✖️ |
GET /user/starred | read | UAT | ✖️ |
GET /user/starred/{owner}/{repo} | read | UAT | ✖️ |
GET /users/{username}/starred | read | UAT IAT | ✖️ |
User permissions for "Watching"
Ponto de extremidade | Access | Tipos de token | Permissões adicionais |
---|---|---|---|
GET /user/subscriptions | read | UAT | ✖️ |
GET /users/{username}/subscriptions | read | UAT IAT | ✖️ |