@@ -19,7 +19,6 @@ shortTitle: GitHub App permissions
1919
2020{% 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 "[ Setting permissions for GitHub Apps] ( /apps/building-github-apps/setting-permissions-for-github-apps/ ) ."
2121
22- <span id =" metadata-permissions " ></span >
2322## Metadata
2423
2524GitHub Apps have the ** Read-only** metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information.
@@ -116,7 +115,6 @@ If you set the metadata permission to **No access** and select a permission that
116115- [ ` GET /users/:username/keys ` ] ( /rest/reference/users#list-public-keys-for-a-user )
117116
118117{% ifversion fpt or ghes or ghec %}
119- <span id =" permission-on-actions " ></span >
120118## Actions
121119
122120- [ ` GET /repos/:owner/:repo/actions/artifacts ` ] ( /rest/reference/actions#list-artifacts-for-a-repository ) (read)
@@ -144,7 +142,6 @@ If you set the metadata permission to **No access** and select a permission that
144142- [ ` GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs ` ] ( /rest/reference/actions#list-workflow-runs ) (read)
145143{% endif %}
146144
147- <span id =" permission-on-administration " ></span >
148145## Administration
149146
150147- [ ` POST /orgs/:org/repos ` ] ( /rest/reference/repos#create-an-organization-repository ) (write)
@@ -260,7 +257,6 @@ If you set the metadata permission to **No access** and select a permission that
260257{% endif %}
261258
262259{% ifversion fpt or ghec %}
263- <span id =" permission-on-blocking " ></span >
264260## Blocking users
265261
266262- [ ` GET /user/blocks ` ] ( /rest/reference/users#list-users-blocked-by-the-authenticated-user ) (read)
@@ -269,7 +265,6 @@ If you set the metadata permission to **No access** and select a permission that
269265- [ ` DELETE /user/blocks/:username ` ] ( /rest/reference/users#unblock-a-user ) (write)
270266{% endif %}
271267
272- <span id =" permission-on-checks " ></span >
273268## Checks
274269
275270- [ ` POST /repos/:owner/:repo/check-runs ` ] ( /rest/reference/checks#create-a-check-run ) (write)
@@ -284,7 +279,6 @@ If you set the metadata permission to **No access** and select a permission that
284279- [ ` GET /repos/:owner/:repo/commits/:sha/check-runs ` ] ( /rest/reference/checks#list-check-runs-for-a-git-reference ) (read)
285280- [ ` GET /repos/:owner/:repo/commits/:sha/check-suites ` ] ( /rest/reference/checks#list-check-suites-for-a-git-reference ) (read)
286281
287- <span id =" permission-on-security-events " ></span >
288282## Code scanning alerts
289283
290284- [ ` GET /repos/:owner/:repo/code-scanning/alerts ` ] ( /rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository ) (read)
@@ -309,20 +303,17 @@ If you set the metadata permission to **No access** and select a permission that
309303{% endif -%}
310304
311305{% ifversion fpt or ghec %}
312- <span id =" permission-on-codespaces " ></span >
313306## Codespaces
314307
315308- [ ` GET /repos/:owner/:repo/codespaces/machines ` ] ( /rest/reference/codespaces#list-available-machine-types-for-a-repository )
316309{% endif %}
317310
318- <span id =" permission-on-statuses " ></span >
319311## Commit statuses
320312
321313- [ ` GET /repos/:owner/:repo/commits/:ref/status ` ] ( /rest/reference/commits#get-the-combined-status-for-a-specific-reference ) (read)
322314- [ ` GET /repos/:owner/:repo/commits/:ref/statuses ` ] ( /rest/reference/commits#list-commit-statuses-for-a-reference ) (read)
323315- [ ` POST /repos/:owner/:repo/statuses/:sha ` ] ( /rest/reference/commits#create-a-commit-status ) (write)
324316
325- <span id =" permission-on-contents " ></span >
326317## Contents
327318
328319- [ ` GET /repos/:owner/:repo/:archive_format/:ref ` ] ( /rest/reference/repos#download-a-repository-archive ) (read)
@@ -483,7 +474,6 @@ If you set the metadata permission to **No access** and select a permission that
483474{% endif %}
484475
485476{% ifversion fpt or ghec or ghes > 3.3%}
486- <span id =" permission-on-dependabot-secrets " ></span >
487477## Dependabot secrets
488478
489479- [ ` GET /repos/:owner/:repo/dependabot/secrets/public-key ` ] ( /rest/reference/dependabot#get-a-repository-public-key ) (read)
@@ -502,7 +492,6 @@ If you set the metadata permission to **No access** and select a permission that
502492- [ ` DELETE /orgs/:org/dependabot/secrets/:secret_name ` ] ( /rest/reference/dependabot#delete-an-organization-secret ) (write)
503493{% endif %}
504494
505- <span id =" permission-on-deployments " ></span >
506495## Deployments
507496
508497- [ ` GET /repos/:owner/:repo/deployments ` ] ( /rest/reference/deployments#list-deployments ) (read)
@@ -514,7 +503,6 @@ If you set the metadata permission to **No access** and select a permission that
514503- [ ` GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id ` ] ( /rest/reference/deployments#get-a-deployment-status ) (read)
515504
516505{% ifversion fpt or ghes or ghec %}
517- <span id =" permission-on-emails " ></span >
518506## Email addresses
519507
520508{% ifversion fpt or ghec -%}
@@ -526,7 +514,6 @@ If you set the metadata permission to **No access** and select a permission that
526514- [ ` GET /user/public_emails ` ] ( /rest/reference/users#list-public-email-addresses-for-the-authenticated-user ) (read)
527515{% endif %}
528516
529- <span id =" permission-on-followers " ></span >
530517## Followers
531518
532519- [ ` GET /user/followers ` ] ( /rest/reference/users#list-followers-of-a-user ) (read)
@@ -535,15 +522,13 @@ If you set the metadata permission to **No access** and select a permission that
535522- [ ` PUT /user/following/:username ` ] ( /rest/reference/users#follow-a-user ) (write)
536523- [ ` DELETE /user/following/:username ` ] ( /rest/reference/users#unfollow-a-user ) (write)
537524
538- <span id =" permission-on-keys " ></span >
539525## Git SSH keys
540526
541527- [ ` GET /user/keys ` ] ( /rest/reference/users#list-public-ssh-keys-for-the-authenticated-user ) (read)
542528- [ ` POST /user/keys ` ] ( /rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user ) (write)
543529- [ ` GET /user/keys/:key_id ` ] ( /rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user ) (read)
544530- [ ` DELETE /user/keys/:key_id ` ] ( /rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user ) (write)
545531
546- <span id =" permission-on-gpg-keys " ></span >
547532## GPG keys
548533
549534- [ ` GET /user/gpg_keys ` ] ( /rest/reference/users#list-gpg-keys-for-the-authenticated-user ) (read)
@@ -552,15 +537,13 @@ If you set the metadata permission to **No access** and select a permission that
552537- [ ` DELETE /user/gpg_keys/:gpg_key_id ` ] ( /rest/reference/users#delete-a-gpg-key-for-the-authenticated-user ) (write)
553538
554539{% ifversion fpt or ghec %}
555- <span id =" permission-on-interaction-limits " ></span >
556540## Interaction limits
557541
558542- [ ` GET /user/interaction-limits ` ] ( /rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories ) (read)
559543- [ ` PUT /user/interaction-limits ` ] ( /rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories ) (write)
560544- [ ` DELETE /user/interaction-limits ` ] ( /rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories ) (write)
561545{% endif %}
562546
563- <span id =" permission-on-issues " ></span >
564547## Issues
565548
566549Issues and pull requests are closely related. For more information, see "[ List issues assigned to the authenticated user] ( /rest/reference/issues#list-issues-assigned-to-the-authenticated-user ) ." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues.
@@ -626,7 +609,6 @@ Issues and pull requests are closely related. For more information, see "[List i
626609- [ ` DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id ` ] ( /rest/reference/reactions#delete-team-discussion-reaction ) (write)
627610- [ ` DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id ` ] ( /rest/reference/reactions#delete-team-discussion-comment-reaction ) (write)
628611
629- <span id =" permission-on-members " ></span >
630612## Members
631613
632614{% ifversion fpt or ghec -%}
@@ -702,7 +684,6 @@ Issues and pull requests are closely related. For more information, see "[List i
702684- [ ` DELETE /teams/:team_id/repos/:owner/:repo ` ] ( /rest/reference/teams#remove-a-repository-from-a-team ) (write)
703685- [ ` GET /teams/:team_id/teams ` ] ( /rest/reference/teams#list-child-teams ) (read)
704686
705- <span id =" permission-on-organization-administration " ></span >
706687## Organization administration
707688
708689- [ ` PATCH /orgs/:org ` ] ( /rest/reference/orgs#update-an-organization ) (write)
@@ -720,13 +701,11 @@ Issues and pull requests are closely related. For more information, see "[List i
720701- [ ` DELETE /orgs/:org/interaction-limits ` ] ( /rest/reference/interactions#remove-interaction-restrictions-for-an-organization ) (write)
721702{% endif %}
722703
723- <span id =" permission-on-organization-events " ></span >
724704## Organization events
725705
726706- [ ` GET /users/:username/events/orgs/:org ` ] ( /rest/reference/activity#list-organization-events-for-the-authenticated-user ) (read)
727707
728708{% ifversion ghes %}
729- <span id =" permission-on-organization-pre-receive-hooks " ></span >
730709## Organization pre-receive hooks
731710
732711- [ ` GET /orgs/:org/pre-receive-hooks ` ] ( /enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization ) (read)
@@ -735,7 +714,6 @@ Issues and pull requests are closely related. For more information, see "[List i
735714- [ ` DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id ` ] ( /enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization ) (write)
736715{% endif %}
737716
738- <span id =" permission-on-organization-projects " ></span >
739717## Organization projects
740718
741719- [ ` POST /orgs/:org/projects ` ] ( /rest/reference/projects#create-an-organization-project ) (write)
@@ -757,7 +735,6 @@ Issues and pull requests are closely related. For more information, see "[List i
757735- [ ` POST /projects/columns/cards/:card_id/moves ` ] ( /rest/reference/projects#move-a-project-card ) (write)
758736
759737{% ifversion fpt or ghec %}
760- <span id =" permission-on-organization-user-blocking " ></span >
761738## Organization user blocking
762739
763740- [ ` GET /orgs/:org/blocks ` ] ( /rest/reference/orgs#list-users-blocked-by-an-organization ) (read)
@@ -766,7 +743,6 @@ Issues and pull requests are closely related. For more information, see "[List i
766743- [ ` DELETE /orgs/:org/blocks/:username ` ] ( /rest/reference/orgs#unblock-a-user-from-an-organization ) (write)
767744{% endif %}
768745
769- <span id =" permission-on-organization-hooks " ></span >
770746## Organization webhooks
771747
772748- [ ` GET /orgs/:org/hooks ` ] ( /rest/reference/orgs#webhooks/#list-organization-webhooks ) (read)
@@ -779,7 +755,6 @@ Issues and pull requests are closely related. For more information, see "[List i
779755### Teams
780756- [ ` DELETE /teams/:team_id/projects/:project_id ` ] ( /rest/reference/teams#remove-a-project-from-a-team ) (read)
781757
782- <span id =" permission-on-pages " ></span >
783758## Pages
784759
785760GitHub Pages can only be created or unpublished by a repository owner or administrator.
@@ -795,12 +770,10 @@ GitHub Pages can only be created or unpublished by a repository owner or adminis
795770- [ ` POST /repos/:owner/:repo/pages/deployment ` ] ( /rest/reference/repos#create-a-github-pages-deployment ) (write)
796771{% endif %}
797772
798- <span id =" permission-on-profile " ></span >
799773## Profile
800774
801775- [ ` PATCH /user ` ] ( /rest/reference/users#update-the-authenticated-user ) (write)
802776
803- <span id =" permission-on-pull-requests " ></span >
804777## Pull requests
805778
806779Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests.
@@ -889,7 +862,6 @@ Pull requests and issues are closely related. If your GitHub App has permissions
889862- [ ` PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals ` ] ( /rest/reference/pulls#dismiss-a-review-for-a-pull-request ) (write)
890863
891864{% ifversion ghes %}
892- <span id =" permission-on-repository-pre-receive-hooks " ></span >
893865## Repository pre-receive hooks
894866
895867- [ ` GET /repos/:owner/:repo/pre-receive-hooks ` ] ( /enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository ) (read)
@@ -898,7 +870,6 @@ Pull requests and issues are closely related. If your GitHub App has permissions
898870- [ ` DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id ` ] ( /enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository ) (write)
899871{% endif %}
900872
901- <span id =" permission-on-repository-projects " ></span >
902873## Repository projects
903874
904875- [ ` GET /projects/:project_id ` ] ( /rest/reference/projects#get-a-project ) (read)
@@ -923,7 +894,6 @@ Pull requests and issues are closely related. If your GitHub App has permissions
923894### Teams
924895- [ ` DELETE /teams/:team_id/projects/:project_id ` ] ( /rest/reference/teams#remove-a-project-from-a-team ) (read)
925896
926- <span id =" permission-on-repository-hooks " ></span >
927897## Repository webhooks
928898
929899- [ ` GET /repos/:owner/:repo/hooks ` ] ( /rest/reference/webhooks#list-repository-webhooks ) (read)
@@ -935,7 +905,6 @@ Pull requests and issues are closely related. If your GitHub App has permissions
935905- [ ` POST /repos/:owner/:repo/hooks/:hook_id/tests ` ] ( /rest/reference/repos#test-the-push-repository-webhook ) (read)
936906
937907{% ifversion fpt or ghec %}
938- <span id =" permission-on-secrets " ></span >
939908## Secrets
940909
941910- [ ` GET /repos/:owner/:repo/actions/secrets/public-key ` ] ( /rest/reference/actions#get-a-repository-public-key ) (read)
@@ -955,7 +924,6 @@ Pull requests and issues are closely related. If your GitHub App has permissions
955924{% endif %}
956925
957926{% ifversion ghes or ghec %}
958- <span id =" permission-on-secret-scanning-alerts " ></span >
959927## Secret scanning alerts
960928
961929- [ ` GET /repos/:owner/:repo/secret-scanning/alerts ` ] ( /rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository ) (read)
@@ -965,7 +933,6 @@ Pull requests and issues are closely related. If your GitHub App has permissions
965933{% endif %}
966934
967935{% ifversion fpt or ghes or ghec %}
968- <span id =" permission-on-self-hosted-runners " ></span >
969936## Self-hosted runners
970937
971938- [ ` GET /orgs/:org/actions/runners/downloads ` ] ( /rest/reference/actions#list-runner-applications-for-an-organization ) (read)
@@ -981,21 +948,18 @@ Pull requests and issues are closely related. If your GitHub App has permissions
981948- [ ` DELETE /orgs/:org/actions/runners/:runner_id/labels/:name ` ] ( /rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization ) (write)
982949{% endif %}
983950
984- <span id =" permission-on-single-file " ></span >
985951## Single file
986952
987953- [ ` GET /repos/:owner/:repo/contents/:path ` ] ( /rest/reference/repos#get-repository-content ) (read)
988954- [ ` PUT /repos/:owner/:repo/contents/:path ` ] ( /rest/reference/repos#create-or-update-file-contents ) (write)
989955- [ ` DELETE /repos/:owner/:repo/contents/:path ` ] ( /rest/reference/repos#delete-a-file ) (write)
990956
991- <span id =" permission-on-starring " ></span >
992957## Starring
993958
994959- [ ` GET /user/starred/:owner/:repo ` ] ( /rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user ) (read)
995960- [ ` PUT /user/starred/:owner/:repo ` ] ( /rest/reference/activity#star-a-repository-for-the-authenticated-user ) (write)
996961- [ ` DELETE /user/starred/:owner/:repo ` ] ( /rest/reference/activity#unstar-a-repository-for-the-authenticated-user ) (write)
997962
998- <span id =" permission-on-team-discussions " ></span >
999963## Team discussions
1000964
1001965- [ ` GET /teams/:team_id/discussions ` ] ( /rest/reference/teams#list-discussions ) (read)
0 commit comments