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 "Setting permissions for GitHub Apps."

Actions

• GET /repos/{owner}/{repo}/actions/artifacts (read)

• GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id} (read)

• DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id} (write)

• GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts (read)

• GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments (read)

• POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments (read)

• GET /repos/{owner}/{repo}/environments (read)

• GET /repos/{owner}/{repo}/actions/jobs/{job_id} (read)

• GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs (read)

• GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs (read)

• GET /repos/{owner}/{repo}/actions/runs (read)

• GET /repos/{owner}/{repo}/actions/runs/{run_id} (read)

• DELETE /repos/{owner}/{repo}/actions/runs/{run_id} (write)

• GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals (read)

• POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel (write)

• GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs (read)

• DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs (write)

• POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun (write)

• GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs (read)

• GET /repos/{owner}/{repo}/actions/workflows (read)

• GET /repos/{owner}/{repo}/actions/workflows/{workflow_id} (read)

• PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable (write)

• POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches (write)

• PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable (write)

Administration

• PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} (write)

• DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} (write)

• POST /orgs/{org}/repos (write)

• PATCH /repos/{owner}/{repo} (write)

• DELETE /repos/{owner}/{repo} (write)

• POST /repos/{owner}/{repo}/forks (write)

• GET /repos/{owner}/{repo}/teams (read)

• POST /repos/{owner}/{repo}/transfer (write)

• POST /user/repos (write)

• GET /repos/{owner}/{repo}/actions/permissions (read)

• PUT /repos/{owner}/{repo}/actions/permissions (write)

• GET /repos/{owner}/{repo}/actions/permissions/selected-actions (read)

• PUT /repos/{owner}/{repo}/actions/permissions/selected-actions (write)

• GET /repos/{owner}/{repo}/autolinks (read)

• POST /repos/{owner}/{repo}/autolinks (write)

• GET /repos/{owner}/{repo}/autolinks/{autolink_id} (read)

• DELETE /repos/{owner}/{repo}/autolinks/{autolink_id} (write)

• PUT /repos/{owner}/{repo}/collaborators/{username} (write)

• DELETE /repos/{owner}/{repo}/collaborators/{username} (write)

• GET /repos/{owner}/{repo}/invitations (read)

• PATCH /repos/{owner}/{repo}/invitations/{invitation_id} (write)

• DELETE /repos/{owner}/{repo}/invitations/{invitation_id} (write)

• GET /user/repository_invitations (read)

• PATCH /user/repository_invitations/{invitation_id} (write)

• DELETE /user/repository_invitations/{invitation_id} (write)

• GET /repos/{owner}/{repo}/keys (read)

• POST /repos/{owner}/{repo}/keys (write)

• GET /repos/{owner}/{repo}/keys/{key_id} (read)

• DELETE /repos/{owner}/{repo}/keys/{key_id} (write)

• POST /repos/{owner}/{repo}/pages (write)

• PUT /repos/{owner}/{repo}/pages (write)

• DELETE /repos/{owner}/{repo}/pages (write)

• GET /repos/{owner}/{repo}/actions/runners (read)

• GET /repos/{owner}/{repo}/actions/runners/{runner_id} (read)

• DELETE /repos/{owner}/{repo}/actions/runners/{runner_id} (write)

• GET /repos/{owner}/{repo}/actions/runners/downloads (read)
• POST /repos/{owner}/{repo}/actions/runners/registration-token (write)
• POST /repos/{owner}/{repo}/actions/runners/remove-token (write)

• PUT /repos/{owner}/{repo}/topics (write)

Checks

• POST /repos/{owner}/{repo}/check-runs (write)
• GET /repos/{owner}/{repo}/check-runs/{check_run_id} (read)
• PATCH /repos/{owner}/{repo}/check-runs/{check_run_id} (write)
• GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations (read)
• POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest (write)
• GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs (read)
• POST /repos/{owner}/{repo}/check-suites (write)
• GET /repos/{owner}/{repo}/check-suites/{check_suite_id} (read)
• POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest (write)
• PATCH /repos/{owner}/{repo}/check-suites/preferences (write)
• POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments (read)

Contents

• POST /repos/{owner}/{repo}/git/blobs (write)
• POST /repos/{owner}/{repo}/git/commits (write)
• POST /repos/{owner}/{repo}/git/refs (write)
• POST /repos/{owner}/{repo}/git/tags (write)
• POST /repos/{owner}/{repo}/git/trees (write)

• PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (write)

• POST /repos/{owner}/{repo}/comments/{comment_id}/reactions (write)

• DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id} (write)

• GET /repos/{owner}/{repo}/branches (read)

• POST /repos/{owner}/{repo}/merge-upstream (write)

• POST /repos/{owner}/{repo}/merges (write)

• PATCH /repos/{owner}/{repo}/comments/{comment_id} (write)

• DELETE /repos/{owner}/{repo}/comments/{comment_id} (write)

• GET /repos/{owner}/{repo}/commits (read)

• POST /repos/{owner}/{repo}/dispatches (write)

• GET /repos/{owner}/{repo}/releases (read)

• POST /repos/{owner}/{repo}/releases (write)

• GET /repos/{owner}/{repo}/releases/{release_id} (read)

• PATCH /repos/{owner}/{repo}/releases/{release_id} (write)

• DELETE /repos/{owner}/{repo}/releases/{release_id} (write)

• GET /repos/{owner}/{repo}/releases/{release_id}/assets (read)

• GET /repos/{owner}/{repo}/releases/assets/{asset_id} (read)

• PATCH /repos/{owner}/{repo}/releases/assets/{asset_id} (write)

• DELETE /repos/{owner}/{repo}/releases/assets/{asset_id} (write)

• POST /repos/{owner}/{repo}/releases/generate-notes (write)

• GET /repos/{owner}/{repo}/releases/latest (read)

Deployments

• POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments (read)
• GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses (read)
• POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses (write)
• GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id} (read)
• GET /repos/{owner}/{repo}/deployments (read)
• POST /repos/{owner}/{repo}/deployments (write)
• GET /repos/{owner}/{repo}/deployments/{deployment_id} (read)
• DELETE /repos/{owner}/{repo}/deployments/{deployment_id} (write)

Emails

• GET /user/emails (read)
• POST /user/emails (write)
• DELETE /user/emails (write)
• GET /user/public_emails (read)

Followers

• GET /user/followers (read)
• GET /user/following (read)
• GET /user/following/{username} (read)
• PUT /user/following/{username} (write)
• DELETE /user/following/{username} (write)

Gists

• POST /gists/{gist_id}/comments (write)
• PATCH /gists/{gist_id}/comments/{comment_id} (write)
• DELETE /gists/{gist_id}/comments/{comment_id} (write)
• POST /gists (write)
• PATCH /gists/{gist_id} (write)
• DELETE /gists/{gist_id} (write)
• POST /gists/{gist_id}/forks (write)
• PUT /gists/{gist_id}/star (write)
• DELETE /gists/{gist_id}/star (write)

Gpg keys

• GET /user/gpg_keys (read)
• POST /user/gpg_keys (write)
• GET /user/gpg_keys/{gpg_key_id} (read)
• DELETE /user/gpg_keys/{gpg_key_id} (write)

Issues

• POST /repos/{owner}/{repo}/issues/{issue_number}/assignees (write)
• DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees (write)
• GET /repos/{owner}/{repo}/issues/{issue_number}/comments (read)
• POST /repos/{owner}/{repo}/issues/{issue_number}/comments (write)
• GET /repos/{owner}/{repo}/issues/comments (read)
• GET /repos/{owner}/{repo}/issues/comments/{comment_id} (read)
• PATCH /repos/{owner}/{repo}/issues/comments/{comment_id} (write)
• DELETE /repos/{owner}/{repo}/issues/comments/{comment_id} (write)
• GET /repos/{owner}/{repo}/issues/{issue_number}/events (read)
• GET /repos/{owner}/{repo}/issues/events (read)
• GET /repos/{owner}/{repo}/issues/events/{event_id} (read)
• GET /repos/{owner}/{repo}/issues/{issue_number}/timeline (read)
• GET /repos/{owner}/{repo}/assignees (read)
• GET /repos/{owner}/{repo}/issues (read)
• POST /repos/{owner}/{repo}/issues (write)
• GET /repos/{owner}/{repo}/issues/{issue_number} (read)
• PATCH /repos/{owner}/{repo}/issues/{issue_number} (write)
• PUT /repos/{owner}/{repo}/issues/{issue_number}/lock (write)
• DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock (write)
• GET /repos/{owner}/{repo}/issues/{issue_number}/labels (read)
• POST /repos/{owner}/{repo}/issues/{issue_number}/labels (write)
• PUT /repos/{owner}/{repo}/issues/{issue_number}/labels (write)
• DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels (write)
• GET /repos/{owner}/{repo}/labels (read)
• POST /repos/{owner}/{repo}/labels (write)
• GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels (read)
• GET /repos/{owner}/{repo}/milestones (read)
• POST /repos/{owner}/{repo}/milestones (write)
• GET /repos/{owner}/{repo}/milestones/{milestone_number} (read)
• PATCH /repos/{owner}/{repo}/milestones/{milestone_number} (write)
• DELETE /repos/{owner}/{repo}/milestones/{milestone_number} (write)
• GET /repos/{owner}/{repo}/issues/{issue_number}/reactions (read)
• POST /repos/{owner}/{repo}/issues/{issue_number}/reactions (write)
• DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id} (write)
• GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions (read)
• POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions (write)
• DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id} (write)

Keys

• GET /user/keys (read)
• POST /user/keys (write)
• GET /user/keys/{key_id} (read)
• DELETE /user/keys/{key_id} (write)

Members

• GET /orgs/{org}/members (read)

• GET /orgs/{org}/members/{username} (read)

• DELETE /orgs/{org}/members/{username} (write)

• GET /orgs/{org}/memberships/{username} (read)

• PUT /orgs/{org}/memberships/{username} (write)

• DELETE /orgs/{org}/memberships/{username} (write)

• GET /orgs/{org}/public_members (read)

• GET /orgs/{org}/public_members/{username} (read)

• PUT /orgs/{org}/public_members/{username} (write)

• DELETE /orgs/{org}/public_members/{username} (write)

• GET /orgs/{org}/outside_collaborators (read)

• PUT /orgs/{org}/outside_collaborators/{username} (write)

• DELETE /orgs/{org}/outside_collaborators/{username} (write)

• GET /orgs/{org}/teams/{team_slug}/projects (read)

• GET /orgs/{org}/teams/{team_slug}/projects/{project_id} (read)

• PUT /orgs/{org}/teams/{team_slug}/projects/{project_id} (read)

• DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id} (read)

• GET /orgs/{org}/teams/{team_slug}/repos (read)

• GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} (read)