About GitHub App permissions
GitHub Apps are created with a set of permissions. Permissions define what resources the GitHub App can access via the API. For more information, see "Choosing permissions for a GitHub App."
To help you choose the correct permissions, you will receive the X-Accepted-GitHub-Permissions
header in the REST API response. The header will tell you what permissions are required in order to access the endpoint. For more information, see "Troubleshooting the REST API."
These permissions are required to access private resources. Some endpoints can also be used to access public resources without these permissions. To see whether an endpoint can access public resources without a permission, see the documentation for that endpoint.
Some endpoints require more than one permission. Other endpoints work with any one permission from a set of permissions. In these cases, the "Additional permissions" column will include a checkmark. For full details about the permissions that are required to use the endpoint, see the documentation for that endpoint.
Business permissions for "Enterprise administration"
Organization permissions for "Administration"
Organization permissions for "Custom repository roles"
Organization permissions for "Events"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
GET /users/{username}/events/orgs/{org} | read | UAT |
Organization permissions for "Members"
Organization permissions for "Organization announcement banners"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
PATCH /orgs/{org}/announcement | write | UAT IAT | |
DELETE /orgs/{org}/announcement | write | UAT IAT | |
GET /orgs/{org}/announcement | read | UAT IAT |
Organization permissions for "Organization dependabot secrets"
Organization permissions for "Personal access token requests"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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 "Pre-receive hooks"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id} | write | UAT IAT | |
DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id} | write | UAT IAT | |
GET /orgs/{org}/pre-receive-hooks | read | UAT IAT | |
GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id} | read | UAT IAT |
Organization permissions for "Projects"
Organization permissions for "Secrets"
Organization permissions for "Self-hosted runners"
Organization permissions for "Team discussions"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Organization permissions for "Webhooks"
Repository permissions for "Actions"
Repository permissions for "Administration"
Repository permissions for "Checks"
Repository permissions for "Code scanning alerts"
Repository permissions for "Commit statuses"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Repository permissions for "Deployments"
Repository permissions for "Environments"
Repository permissions for "Issues"
Repository permissions for "Metadata"
Repository permissions for "Pages"
Repository permissions for "Pre-receive hooks"
Repository permissions for "Projects"
Repository permissions for "Pull requests"
Repository permissions for "Secret scanning alerts"
Repository permissions for "Secrets"
Repository permissions for "Variables"
Repository permissions for "Webhooks"
Repository permissions for "Workflows"
User permissions for "Email addresses"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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 "Notifications"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
GET /notifications | read | UAT | Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint. |
User permissions for "Profile"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
PATCH /user | write | UAT | |
POST /user/social_accounts | write | UAT | |
DELETE /user/social_accounts | write | UAT |
User permissions for "SSH signing keys"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
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"
User permissions for "Watching"
Endpoint | Access | Token types | Additional permissions |
---|---|---|---|
GET /user/subscriptions | read | UAT | |
GET /users/{username}/subscriptions | read | UAT IAT |