30 lines
1.7 KiB
Markdown
30 lines
1.7 KiB
Markdown
---
|
|
title: Permissions required for GitHub Apps
|
|
intro: 'These are the permissions required for a {% data variables.product.prodname_github_app %} to use each REST API endpoint that works with {% data variables.product.prodname_github_apps %}.'
|
|
redirect_from:
|
|
- /v3/apps/permissions
|
|
- /rest/reference/permissions-required-for-github-apps
|
|
- /rest/overview/permissions-required-for-github-apps
|
|
versions:
|
|
fpt: '*'
|
|
ghes: '*'
|
|
ghae: '*'
|
|
ghec: '*'
|
|
topics:
|
|
- API
|
|
shortTitle: Permissions for GitHub Apps
|
|
autogenerated: github-apps
|
|
---
|
|
|
|
## About {% data variables.product.prodname_github_app %} permissions
|
|
|
|
{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/setting-permissions-for-github-apps)."
|
|
|
|
{% data reusables.rest-api.permission-header %}
|
|
|
|
These permissions are required to access private resources with the following endpoints. Some endpoints can also be used to access public resources without these permissions.
|
|
|
|
Some endpoints require additional permissions. When this is the case, the "Additional permissions" column will indicate the other permissions that are required to use the endpoint. Some endpoints that require write access to the repository "Contents" permission also require write access to the repository "Workflows" permission if the request will affect workflow files. In these cases, the repository "Workflows" permission is indicated as an additional permission even though it is not always required to use the endpoint.
|
|
|
|
<!-- The content of this page is rendered as a NextJS page component. -->
|