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.
Enterprise permissions for "Copilot usage records"
Enterprise permissions for "Custom enterprise roles"
Enterprise permissions for "Custom properties"
Enterprise permissions for "Enterprise AI controls"
Enterprise permissions for "Enterprise Copilot metrics"
Enterprise permissions for "Enterprise Licensing"
Enterprise permissions for "Enterprise SCIM"
Enterprise permissions for "Enterprise billing"
Enterprise permissions for "Enterprise credentials"
Enterprise permissions for "Enterprise custom properties for organizations"
Enterprise permissions for "Enterprise innersource vulnerabilities"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| POST /enterprises/{enterprise}/innersource-vulnerabilities/sync | write | IAT | |
| GET /enterprises/{enterprise}/innersource-vulnerabilities/sync/status/{job_id} | write | IAT |
Enterprise permissions for "Enterprise organization installation repositories"
Enterprise permissions for "Enterprise organization installations"
Enterprise permissions for "Enterprise teams"
Organization permissions for "API Insights"
Organization permissions for "Administration"
Organization permissions for "Agent secrets"
Organization permissions for "Agent variables"
Organization permissions for "Blocking users"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| 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 "Campaigns"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| POST /orgs/{org}/campaigns | write | UAT IAT | |
| PATCH /orgs/{org}/campaigns/{campaign_number} | write | UAT IAT | |
| DELETE /orgs/{org}/campaigns/{campaign_number} | write | UAT IAT | |
| GET /orgs/{org}/campaigns | read | UAT IAT | |
| GET /orgs/{org}/campaigns/{campaign_number} | read | UAT IAT |
Organization permissions for "Copilot Spaces"
Organization permissions for "Copilot agent settings"
Organization permissions for "Copilot content exclusion"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| PUT /orgs/{org}/copilot/content_exclusion | write | UAT IAT | |
| GET /orgs/{org}/copilot/content_exclusion | read | UAT IAT |
Organization permissions for "Custom organization roles"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| 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 for organizations"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| PATCH /organizations/{org}/org-properties/values | write | UAT IAT | |
| GET /organizations/{org}/org-properties/values | read | UAT IAT |
Organization permissions for "Custom properties"
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 "GitHub Copilot Business"
Organization permissions for "Hosted runner custom images"
Organization permissions for "Issue Fields"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| POST /orgs/{org}/issue-fields | write | UAT IAT | |
| PATCH /orgs/{org}/issue-fields/{issue_field_id} | write | UAT IAT | |
| DELETE /orgs/{org}/issue-fields/{issue_field_id} | write | UAT IAT | |
| GET /orgs/{org}/issue-fields | read | UAT IAT |
Organization permissions for "Issue Types"
| Endpoint | Access | Token types | Additional permissions |
|---|---|---|---|
| POST /orgs/{org}/issue-types | write | UAT IAT | |
| PUT /orgs/{org}/issue-types/{issue_type_id} | write | UAT IAT | |
| DELETE /orgs/{org}/issue-types/{issue_type_id} | write | UAT IAT | |
| GET /orgs/{org}/issue-types | read | UAT IAT |