Permissions required for GitHub Apps

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"

Endpoint	Access	Token types	Additional permissions
GET /enterprises/{enterprise}/copilot/usage-records	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

Enterprise permissions for "Custom enterprise roles"

Endpoint	Access	Token types
DELETE /enterprises/{enterprise}/enterprise-roles/teams/{team_slug}	write	UAT IAT
PUT /enterprises/{enterprise}/enterprise-roles/teams/{team_slug}/{role_id}	write	UAT IAT
DELETE /enterprises/{enterprise}/enterprise-roles/teams/{team_slug}/{role_id}	write	UAT IAT
DELETE /enterprises/{enterprise}/enterprise-roles/users/{username}	write	UAT IAT
PUT /enterprises/{enterprise}/enterprise-roles/users/{username}/{role_id}	write	UAT IAT
DELETE /enterprises/{enterprise}/enterprise-roles/users/{username}/{role_id}	write	UAT IAT
GET /enterprises/{enterprise}/enterprise-roles	read	UAT IAT
GET /enterprises/{enterprise}/enterprise-roles/{role_id}	read	UAT IAT
GET /enterprises/{enterprise}/enterprise-roles/{role_id}/teams	read	UAT IAT
GET /enterprises/{enterprise}/enterprise-roles/{role_id}/users	read	UAT IAT

Enterprise permissions for "Custom properties"

Endpoint	Access	Token types
PATCH /enterprises/{enterprise}/properties/schema	write	UAT IAT
PUT /enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote	write	UAT IAT
PUT /enterprises/{enterprise}/properties/schema/{custom_property_name}	write	UAT IAT
DELETE /enterprises/{enterprise}/properties/schema/{custom_property_name}	write	UAT IAT
GET /enterprises/{enterprise}/properties/schema	read	UAT IAT
GET /enterprises/{enterprise}/properties/schema/{custom_property_name}	read	UAT IAT

Enterprise permissions for "Enterprise AI controls"

Endpoint	Access	Token types
PUT /enterprises/{enterprise}/copilot/content_exclusion	write	UAT IAT
PUT /enterprises/{enterprise}/copilot/custom-agents/source	write	UAT IAT
DELETE /enterprises/{enterprise}/copilot/custom-agents/source	write	UAT IAT
GET /enterprises/{enterprise}/copilot/content_exclusion	read	UAT IAT
GET /enterprises/{enterprise}/copilot/custom-agents	read	UAT IAT
GET /enterprises/{enterprise}/copilot/custom-agents/source	read	UAT IAT

Enterprise permissions for "Enterprise Copilot metrics"

Endpoint	Access	Token types
GET /enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day	read	UAT IAT
GET /enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest	read	UAT IAT
GET /enterprises/{enterprise}/copilot/metrics/reports/repos-1-day	read	UAT IAT
GET /enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day	read	UAT IAT
GET /enterprises/{enterprise}/copilot/metrics/reports/users-1-day	read	UAT IAT
GET /enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest	read	UAT IAT

Enterprise permissions for "Enterprise Licensing"

Endpoint	Access	Token types
PUT /enterprises/{enterprise}/visual-studio-subscriptions/{visual_studio_subscription_id}	write	UAT IAT
DELETE /enterprises/{enterprise}/visual-studio-subscriptions/{visual_studio_subscription_id}	write	UAT IAT
GET /enterprises/{enterprise}/visual-studio-subscriptions	read	UAT IAT

Enterprise permissions for "Enterprise SCIM"

Endpoint	Access	Token types
POST /scim/v2/enterprises/{enterprise}/Groups	write	UAT IAT
PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}	write	UAT IAT
PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}	write	UAT IAT
DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}	write	UAT IAT
POST /scim/v2/enterprises/{enterprise}/Users	write	UAT IAT
PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}	write	UAT IAT
PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}	write	UAT IAT
DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}	write	UAT IAT
GET /scim/v2/enterprises/{enterprise}/Groups	read	UAT IAT
GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}	read	UAT IAT
GET /scim/v2/enterprises/{enterprise}/Users	read	UAT IAT
GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}	read	UAT IAT

Enterprise permissions for "Enterprise billing"

Endpoint	Access	Token types	Additional permissions
POST /enterprises/{enterprise}/settings/billing/budgets	write	UAT IAT
PATCH /enterprises/{enterprise}/settings/billing/budgets/{budget_id}	write	UAT IAT
DELETE /enterprises/{enterprise}/settings/billing/budgets/{budget_id}	write	UAT IAT
POST /enterprises/{enterprise}/settings/billing/cost-centers	write	UAT IAT
PATCH /enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}	write	UAT IAT
DELETE /enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}	write	UAT IAT
POST /enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource	write	UAT IAT
DELETE /enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource	write	UAT IAT
GET /enterprises/{enterprise}/settings/billing/ai_credit/usage	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/budgets	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/budgets/{budget_id}	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/cost-centers	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/premium_request/usage	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/reports	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
POST /enterprises/{enterprise}/settings/billing/reports	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
GET /enterprises/{enterprise}/settings/billing/reports/{report_id}	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
GET /enterprises/{enterprise}/settings/billing/usage	read	UAT IAT
GET /enterprises/{enterprise}/settings/billing/usage/summary	read	UAT IAT

Enterprise permissions for "Enterprise credentials"

Endpoint	Access	Token types
DELETE /enterprises/{enterprise}/credential-authorizations	write	IAT
POST /enterprises/{enterprise}/credential-authorizations/revoke-all	write	UAT IAT
POST /enterprises/{enterprise}/credential-authorizations/revoke-credential-type	write	UAT IAT
POST /enterprises/{enterprise}/credential-authorizations/{username}/revoke	write	UAT IAT
POST /enterprises/{enterprise}/credential-authorizations/{username}/revoke-credential-type	write	UAT IAT

Enterprise permissions for "Enterprise custom properties for organizations"

Endpoint	Access	Token types
PATCH /enterprises/{enterprise}/org-properties/schema	admin	UAT IAT
PUT /enterprises/{enterprise}/org-properties/schema/{custom_property_name}	admin	UAT IAT
DELETE /enterprises/{enterprise}/org-properties/schema/{custom_property_name}	admin	UAT IAT
PATCH /enterprises/{enterprise}/org-properties/values	write	UAT IAT
GET /enterprises/{enterprise}/org-properties/schema	read	UAT IAT
GET /enterprises/{enterprise}/org-properties/schema/{custom_property_name}	read	UAT IAT
GET /enterprises/{enterprise}/org-properties/values	read	UAT IAT

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"

Endpoint	Access	Token types	Additional permissions
PATCH /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
PATCH /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
PATCH /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
GET /enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
GET /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

Enterprise permissions for "Enterprise organization installations"

Endpoint	Access	Token types	Additional permissions
POST /enterprises/{enterprise}/apps/organizations/{org}/installations	write	UAT IAT
DELETE /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}	write	UAT IAT
PATCH /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
PATCH /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
PATCH /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
GET /enterprises/{enterprise}/apps/installable_organizations	read	UAT IAT
GET /enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
GET /enterprises/{enterprise}/apps/organizations/{org}/installations	read	UAT IAT
GET /enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories	read	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

Enterprise permissions for "Enterprise teams"

Endpoint	Access	Token types
POST /enterprises/{enterprise}/teams	write	UAT IAT
POST /enterprises/{enterprise}/teams/{enterprise-team}/memberships/add	write	UAT IAT
POST /enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove	write	UAT IAT
PUT /enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}	write	UAT IAT
DELETE /enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}	write	UAT IAT
POST /enterprises/{enterprise}/teams/{enterprise-team}/organizations/add	write	UAT IAT
POST /enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove	write	UAT IAT
PUT /enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}	write	UAT IAT
DELETE /enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}	write	UAT IAT
PATCH /enterprises/{enterprise}/teams/{team_slug}	write	UAT IAT
DELETE /enterprises/{enterprise}/teams/{team_slug}	write	UAT IAT
GET /enterprises/{enterprise}/members/{username}/teams	read	UAT IAT
GET /enterprises/{enterprise}/teams	read	UAT IAT
GET /enterprises/{enterprise}/teams/{enterprise-team}/memberships	read	UAT IAT
GET /enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}	read	UAT IAT
GET /enterprises/{enterprise}/teams/{enterprise-team}/organizations	read	UAT IAT
GET /enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}	read	UAT IAT
GET /enterprises/{enterprise}/teams/{team_slug}	read	UAT IAT

Organization permissions for "API Insights"

Endpoint	Access	Token types
GET /orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}	read	UAT IAT
GET /orgs/{org}/insights/api/subject-stats	read	UAT IAT
GET /orgs/{org}/insights/api/summary-stats	read	UAT IAT
GET /orgs/{org}/insights/api/summary-stats/users/{user_id}	read	UAT IAT
GET /orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}	read	UAT IAT
GET /orgs/{org}/insights/api/time-stats	read	UAT IAT
GET /orgs/{org}/insights/api/time-stats/users/{user_id}	read	UAT IAT
GET /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}	read	UAT IAT
GET /orgs/{org}/insights/api/user-stats/{user_id}	read	UAT IAT

Organization permissions for "Administration"

Endpoint	Access	Token types	Additional permissions
PUT /organizations/{org}/actions/cache/retention-limit	write	UAT IAT
PUT /organizations/{org}/actions/cache/storage-limit	write	UAT IAT
PATCH /orgs/{org}	write	UAT IAT
DELETE /orgs/{org}	write	UAT IAT
POST /orgs/{org}/actions/hosted-runners	write	UAT IAT
PATCH /orgs/{org}/actions/hosted-runners/{hosted_runner_id}	write	UAT IAT
DELETE /orgs/{org}/actions/hosted-runners/{hosted_runner_id}	write	UAT IAT
POST /orgs/{org}/actions/oidc/customization/properties/repo	write	UAT IAT
DELETE /orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}	write	UAT IAT
PUT /orgs/{org}/actions/oidc/customization/sub	write	UAT IAT
PUT /orgs/{org}/actions/permissions	write	UAT IAT
PUT /orgs/{org}/actions/permissions/artifact-and-log-retention	write	UAT IAT
PUT /orgs/{org}/actions/permissions/fork-pr-contributor-approval	write	UAT IAT
PUT /orgs/{org}/actions/permissions/fork-pr-workflows-private-repos	write	UAT IAT
PUT /orgs/{org}/actions/permissions/repositories	write	UAT IAT
PUT /orgs/{org}/actions/permissions/repositories/{repository_id}	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}	write	UAT IAT	Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
PUT /orgs/{org}/actions/permissions/selected-actions	write	UAT IAT
PUT /orgs/{org}/actions/permissions/self-hosted-runners	write	UAT IAT
PUT /orgs/{org}/actions/permissions/self-hosted-runners/repositories	write	UAT IAT

In this article