1
0
mirror of synced 2026-01-01 18:05:46 -05:00
Files
docs/content/rest/overview/permissions-required-for-github-apps.md
2023-04-24 17:32:37 +00:00

98 KiB

title, intro, redirect_from, versions, topics, shortTitle
title intro redirect_from versions topics shortTitle
Permissions required for GitHub Apps You can find the required permissions for each {% data variables.product.prodname_github_app %}-compatible endpoint.
/v3/apps/permissions
/rest/reference/permissions-required-for-github-apps
fpt ghes ghae ghec
* * * *
API
GitHub App permissions

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."

Actions

{% ifversion fpt or ghec or ghes > 3.7 %}

Actions variables

{% endif %}

Administration

{% ifversion fpt or ghec %}

Blocking

{% endif %}

Checks

{% ifversion fpt or ghec or ghes %}- POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments (read){% endif %}

{% ifversion fpt or ghec %}

Codespaces

{% endif %}

{% ifversion fpt or ghec %}

Codespaces lifecycle admin

{% endif %}

{% ifversion fpt or ghec %}

Codespaces metadata

{% endif %}

{% ifversion fpt or ghec %}

Codespaces secrets

{% endif %}

{% ifversion fpt or ghec %}

Codespaces user secrets

{% endif %}

Contents

{% ifversion fpt or ghec or ghes %}

Dependabot secrets

{% endif %}

Deployments

{% ifversion fpt or ghec or ghes %}- POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments (read){% endif %}

{% ifversion fpt or ghec or ghes %}

Emails

{% ifversion fpt or ghec or ghes %}- GET /user/emails (read){% endif %} {% ifversion fpt or ghec or ghes %}- POST /user/emails (write){% endif %} {% ifversion fpt or ghec or ghes %}- DELETE /user/emails (write){% endif %} {% ifversion fpt or ghec or ghes %}- GET /user/public_emails (read){% endif %} {% ifversion fpt or ghec %}- PATCH /user/email/visibility (write){% endif %}

{% endif %}

{% ifversion ghec or ghes %}

Enterprise administration

{% ifversion ghec or ghes %}- GET /enterprises/{enterprise}/settings/billing/advanced-security (write){% endif %} {% ifversion ghec or ghes > 3.4 %}- GET /enterprises/{enterprise}/actions/cache/usage (write){% endif %} {% ifversion ghes > 3.4 %}- GET /enterprises/{enterprise}/actions/cache/usage-policy (write){% endif %} {% ifversion ghes > 3.4 %}- PATCH /enterprises/{enterprise}/actions/cache/usage-policy (write){% endif %} {% ifversion ghes > 3.5 %}- GET /scim/v2/Groups (write){% endif %} {% ifversion ghes > 3.5 %}- POST /scim/v2/Groups (write){% endif %} {% ifversion ghes > 3.5 %}- GET /scim/v2/Groups/{scim_group_id} (write){% endif %} {% ifversion ghes > 3.5 %}- PUT /scim/v2/Groups/{scim_group_id} (write){% endif %} {% ifversion ghes > 3.5 %}- PATCH /scim/v2/Groups/{scim_group_id} (write){% endif %} {% ifversion ghes > 3.5 %}- DELETE /scim/v2/Groups/{scim_group_id} (write){% endif %} {% ifversion ghes > 3.5 %}- GET /scim/v2/Users (write){% endif %} {% ifversion ghes > 3.5 %}- POST /scim/v2/Users (write){% endif %} {% ifversion ghes > 3.5 %}- GET /scim/v2/Users/{scim_user_id} (write){% endif %} {% ifversion ghes > 3.5 %}- PUT /scim/v2/Users/{scim_user_id} (write){% endif %} {% ifversion ghes > 3.5 %}- DELETE /scim/v2/Users/{scim_user_id} (write){% endif %}

{% endif %}

{% ifversion fpt or ghec or ghes > 3.7 %}

Environments

{% ifversion fpt or ghec or ghes %}- GET /repositories/{repository_id}/environments/{environment_name}/secrets (read){% endif %} {% ifversion fpt or ghec or ghes %}- GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key (read){% endif %} {% ifversion fpt or ghec or ghes %}- GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} (read){% endif %} {% ifversion fpt or ghec or ghes %}- PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} (write){% endif %} {% ifversion fpt or ghec or ghes %}- DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} (write){% endif %} {% ifversion fpt or ghec or ghes > 3.7 %}- GET /repositories/{repository_id}/environments/{environment_name}/variables (read){% endif %} {% ifversion fpt or ghec or ghes > 3.7 %}- POST /repositories/{repository_id}/environments/{environment_name}/variables (write){% endif %} {% ifversion fpt or ghec or ghes > 3.7 %}- GET /repositories/{repository_id}/environments/{environment_name}/variables/{name} (read){% endif %} {% ifversion fpt or ghec or ghes > 3.7 %}- PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name} (write){% endif %} {% ifversion fpt or ghec or ghes > 3.7 %}- DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name} (write){% endif %}

{% endif %}

Followers

Gists

{% ifversion fpt or ghec or ghes > 3.6 %}

Git signing ssh public keys

{% endif %}

Gpg keys

{% ifversion fpt or ghec %}

Interaction limits

{% endif %}

Issues

Keys

Members

Metadata

Notifications

{% ifversion fpt or ghec or ghes > 3.7 %}

Organization actions variables

{% endif %}

Organization administration

{% ifversion fpt or ghec %}

Organization codespaces

{% endif %}

{% ifversion fpt or ghec %}

Organization codespaces secrets

{% endif %}

{% ifversion fpt or ghec %}

Organization codespaces settings

{% endif %}

{% ifversion ghec or ghes %}

Organization custom roles

{% endif %}

{% ifversion fpt or ghec or ghes %}

Organization dependabot secrets

{% endif %}

Organization events

Organization hooks

{% ifversion ghes %}

Organization pre receive hooks

{% endif %}

Organization projects

Organization secrets

Organization self hosted runners

{% ifversion fpt or ghec %}

Organization user blocking

{% endif %}

Pages

{% ifversion fpt or ghec or ghes > 3.9 %}

{% data variables.product.pat_generic_caps %} requests

{% endif %}

{% ifversion fpt or ghec or ghes > 3.9 %}

{% data variables.product.pat_generic_caps %}s

{% endif %}

{% ifversion fpt or ghec %}

Plan

{% endif %}

Profile

Pull requests

Repository hooks

{% ifversion ghes %}

Repository pre receive hooks

{% endif %}

Repository projects

Secret scanning alerts

Secrets

Security events

Starring

Statuses

Team discussions

{% ifversion fpt or ghec or ghes > 3.7 %}

Vulnerability alerts

{% endif %}

Watching

Workflows