77 KiB
77 KiB
title, intro, redirect_from, versions, topics, miniTocMaxHeadingLevel, shortTitle
| title | intro | redirect_from | versions | topics | miniTocMaxHeadingLevel | shortTitle | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Permissions required for GitHub Apps | You can find the required permissions for each {% data variables.product.prodname_github_app %}-compatible endpoint. |
|
|
|
3 | 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 "Setting permissions for GitHub Apps."
Actions
{% ifversion fpt or ghec or ghes > 3.4 %}- GET /repos/{owner}/{repo}/actions/cache/usage (read){% endif %}
{% ifversion ghes > 3.4 %}- GET /repos/{owner}/{repo}/actions/cache/usage-policy (read){% endif %}
{% ifversion fpt or ghec or ghes > 3.6 %}- GET /repos/{owner}/{repo}/actions/caches (read){% endif %}
{% ifversion fpt or ghec or ghes > 3.6 %}- DELETE /repos/{owner}/{repo}/actions/caches (write){% endif %}
{% ifversion fpt or ghec or ghes > 3.6 %}- DELETE /repos/{owner}/{repo}/actions/caches/{cache_id} (write){% endif %}
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) {% ifversion fpt or ghec or ghes %}-GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments(read){% endif %} {% ifversion fpt or ghec or ghes %}-POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments(read){% endif %}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) {% ifversion fpt or ghec or ghes > 3.4 %}-POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun(write){% endif %} {% ifversion fpt or ghec or ghae or ghes > 3.4 %}-GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs(read){% endif %}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) {% ifversion fpt or ghec or ghes %}-GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals(read){% endif %} {% ifversion fpt or ghec %}-POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve(write){% endif %} {% ifversion fpt or ghec or ghae or ghes > 3.4 %}-GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}(read){% endif %} {% ifversion fpt or ghec or ghae or ghes > 3.4 %}-GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs(read){% endif %}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) {% ifversion fpt or ghec or ghes > 3.4 %}-POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs(write){% endif %} {% ifversion fpt or ghec or ghae %}-GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing(read){% endif %}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) {% ifversion fpt or ghec or ghae %}-GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing(read){% endif %}
Administration
{% ifversion ghes > 3.4 %}- PATCH /repos/{owner}/{repo}/actions/cache/usage-policy (write){% endif %}
{% ifversion fpt or ghec %}- PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name} (write){% endif %}
{% ifversion fpt or ghec %}- DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name} (write){% endif %}
{% ifversion fpt or ghec %}- GET /repos/{owner}/{repo}/interaction-limits (read){% endif %}
{% ifversion fpt or ghec %}- PUT /repos/{owner}/{repo}/interaction-limits (write){% endif %}
{% ifversion fpt or ghec %}- DELETE /repos/{owner}/{repo}/interaction-limits (write){% endif %}
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) {% ifversion ghes > 3.3 %}-GET /repos/{owner}/{repo}/replicas/caches(read){% endif %}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) {% ifversion fpt or ghec or ghes > 3.4 %}-GET /repos/{owner}/{repo}/actions/permissions/access(read){% endif %} {% ifversion fpt or ghec or ghes > 3.4 %}-PUT /repos/{owner}/{repo}/actions/permissions/access(write){% endif %}GET /repos/{owner}/{repo}/actions/permissions/selected-actions(read)PUT /repos/{owner}/{repo}/actions/permissions/selected-actions(write) {% ifversion fpt or ghec or ghes > 3.5 %}-GET /repos/{owner}/{repo}/actions/permissions/workflow(read){% endif %} {% ifversion fpt or ghec or ghes > 3.5 %}-PUT /repos/{owner}/{repo}/actions/permissions/workflow(write){% endif %}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) {% ifversion fpt or ghec %}-PUT /repos/{owner}/{repo}/automated-security-fixes(write){% endif %} {% ifversion fpt or ghec %}-DELETE /repos/{owner}/{repo}/automated-security-fixes(write){% endif %}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) {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/pages/health(write){% endif %}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) {% ifversion fpt or ghec or ghes > 3.3 %}-GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels(read){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels(write){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels(write){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels(write){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}(write){% endif %}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) {% ifversion fpt or ghec or ghes > 3.4 %}-GET /repos/{owner}/{repo}/tags/protection(read){% endif %} {% ifversion fpt or ghec or ghes > 3.4 %}-POST /repos/{owner}/{repo}/tags/protection(write){% endif %} {% ifversion fpt or ghec or ghes > 3.4 %}-DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}(write){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/vulnerability-alerts(read){% endif %} {% ifversion fpt or ghec %}-PUT /repos/{owner}/{repo}/vulnerability-alerts(write){% endif %} {% ifversion fpt or ghec %}-DELETE /repos/{owner}/{repo}/vulnerability-alerts(write){% endif %}PUT /repos/{owner}/{repo}/topics(write) {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/traffic/clones(read){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/traffic/popular/paths(read){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/traffic/popular/referrers(read){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/traffic/views(read){% endif %}
{% ifversion fpt or ghec %}
Blocking
GET /user/blocks(read)GET /user/blocks/{username}(read)PUT /user/blocks/{username}(write)DELETE /user/blocks/{username}(write)
{% endif %}
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) {% ifversion fpt or ghec or ghes %}-POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments(read){% endif %}
{% ifversion fpt or ghec %}
Codespaces
GET /orgs/{org}/codespaces(read)GET /repos/{owner}/{repo}/codespaces(read)POST /repos/{owner}/{repo}/codespaces(write)GET /repos/{owner}/{repo}/codespaces/new(write)POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces(write)GET /user/codespaces(read)POST /user/codespaces(write)GET /user/codespaces/{codespace_name}(read)PATCH /user/codespaces/{codespace_name}(write)DELETE /user/codespaces/{codespace_name}(write)
Codespaces lifecycle admin
POST /user/codespaces/{codespace_name}/exports(write)GET /user/codespaces/{codespace_name}/exports/{export_id}(read)POST /user/codespaces/{codespace_name}/start(write)POST /user/codespaces/{codespace_name}/stop(write)
Codespaces metadata
GET /repos/{owner}/{repo}/codespaces/devcontainers(read)GET /repos/{owner}/{repo}/codespaces/machines(read)GET /user/codespaces/{codespace_name}/machines(read)
Codespaces secrets
GET /repos/{owner}/{repo}/codespaces/secrets(write)GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}(write)PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}(write)DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}(write)GET /repos/{owner}/{repo}/codespaces/secrets/public-key(write)
Codespaces user secrets
GET /user/codespaces/secrets(read)GET /user/codespaces/secrets/{secret_name}(read)PUT /user/codespaces/secrets/{secret_name}(write)DELETE /user/codespaces/secrets/{secret_name}(write)GET /user/codespaces/secrets/public-key(read)GET /user/codespaces/secrets/{secret_name}/repositories(read)PUT /user/codespaces/secrets/{secret_name}/repositories(write)PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}(write)DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}(write)
{% endif %}
Contents
{% ifversion fpt or ghec or ghae or ghes > 3.4 %}- GET /repos/{owner}/{repo}/codeowners/errors (read){% endif %}
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) {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/import(read){% endif %} {% ifversion fpt or ghec %}-PUT /repos/{owner}/{repo}/import(write){% endif %} {% ifversion fpt or ghec %}-PATCH /repos/{owner}/{repo}/import(write){% endif %} {% ifversion fpt or ghec %}-DELETE /repos/{owner}/{repo}/import(write){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/import/authors(read){% endif %} {% ifversion fpt or ghec %}-PATCH /repos/{owner}/{repo}/import/authors/{author_id}(write){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/import/large_files(read){% endif %} {% ifversion fpt or ghec %}-PATCH /repos/{owner}/{repo}/import/lfs(write){% endif %}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) {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/code-scanning/codeql/databases(read){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}(read){% endif %}PATCH /repos/{owner}/{repo}/comments/{comment_id}(write)DELETE /repos/{owner}/{repo}/comments/{comment_id}(write)GET /repos/{owner}/{repo}/commits(read) {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/community/profile(read){% endif %} {% ifversion fpt or ghec or ghes > 3.5 %}-GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}(read){% endif %}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) {% ifversion fpt or ghec or ghes %}-POST /repos/{owner}/{repo}/releases/generate-notes(write){% endif %}GET /repos/{owner}/{repo}/releases/latest(read)
{% ifversion fpt or ghec or ghes > 3.3 %}
Dependabot secrets
GET /repos/{owner}/{repo}/dependabot/secrets(read)GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}(read)PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}(write)DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}(write)GET /repos/{owner}/{repo}/dependabot/secrets/public-key(read)
{% endif %}
Deployments
{% ifversion fpt or ghec or ghes %}- POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments (read){% endif %}
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)
{% ifversion fpt or ghec or ghes %}
Emails
{% ifversion fpt or ghec %}- PATCH /user/email/visibility (write){% endif %}
{% 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 %}
{% endif %}
{% ifversion fpt or ghec or ghes > 3.3 %}
Enterprise administration
{% ifversion fpt or ghec or ghes > 3.3 %}- GET /enterprises/{enterprise}/settings/billing/advanced-security (write){% endif %}
{% ifversion fpt or 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 %}
{% endif %}
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)
{% ifversion fpt or ghec or ghes > 3.6 %}
Git signing ssh public keys
GET /user/ssh_signing_keys(read)POST /user/ssh_signing_keys(write)GET /user/ssh_signing_keys/{ssh_signing_key_id}(read)DELETE /user/ssh_signing_keys/{ssh_signing_key_id}(write)
{% endif %}
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)
{% ifversion fpt or ghec %}
Interaction limits
PUT /user/interaction-limits(write)GET /user/interaction-limits(read)DELETE /user/interaction-limits(write)
{% endif %}
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
{% ifversion ghec or ghae or ghes > 3.5 %}- PATCH /orgs/{org}/teams/{team_slug}/external-groups (write){% endif %}
{% ifversion ghec or ghae or ghes > 3.5 %}- DELETE /orgs/{org}/teams/{team_slug}/external-groups (write){% endif %}
{% ifversion ghec or ghae or ghes > 3.5 %}- GET /orgs/{org}/external-group/{group_id} (write){% endif %}
{% ifversion ghec or ghae or ghes > 3.5 %}- GET /orgs/{org}/external-groups (write){% endif %}
{% ifversion fpt or ghec %}- GET /orgs/{org}/failed_invitations (read){% endif %}
{% ifversion fpt or ghec %}- GET /orgs/{org}/invitations (read){% endif %}
{% ifversion fpt or ghec %}- POST /orgs/{org}/invitations (write){% endif %}
{% ifversion fpt or ghec %}- DELETE /orgs/{org}/invitations/{invitation_id} (write){% endif %}
{% ifversion fpt or ghec %}- GET /orgs/{org}/invitations/{invitation_id}/teams (read){% endif %}
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) {% ifversion fpt or ghec or ghes %}-GET /orgs/{org}/public_members(read){% endif %} {% ifversion fpt or ghec or ghes %}-GET /orgs/{org}/public_members/{username}(read){% endif %} {% ifversion fpt or ghec or ghes %}-PUT /orgs/{org}/public_members/{username}(write){% endif %} {% ifversion fpt or ghec or ghes %}-DELETE /orgs/{org}/public_members/{username}(write){% endif %}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)PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}(read)DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}(read)PATCH /orgs/{org}/teams/{team_slug}(write)DELETE /orgs/{org}/teams/{team_slug}(write) {% ifversion fpt or ghec %}-GET /orgs/{org}/teams/{team_slug}/invitations(read){% endif %}GET /orgs/{org}/teams/{team_slug}/members(read)GET /orgs/{org}/teams/{team_slug}/memberships/{username}(read)PUT /orgs/{org}/teams/{team_slug}/memberships/{username}(write)DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}(write)GET /orgs/{org}/teams/{team_slug}/teams(read)GET /orgs/{org}/teams/{team_slug}(read)GET /orgs/{org}/teams(read)POST /orgs/{org}/teams(write)GET /user/memberships/orgs/{org}(read)PATCH /user/memberships/orgs/{org}(write)
Metadata
{% ifversion fpt or ghec %}- GET /user/codespaces/secrets/{secret_name}/repositories (read){% endif %}
{% ifversion fpt or ghec %}- PUT /user/codespaces/secrets/{secret_name}/repositories (read){% endif %}
{% ifversion fpt or ghec %}- PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id} (read){% endif %}
{% ifversion fpt or ghec %}- DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id} (read){% endif %}
GET /repos/{owner}/{repo}/events(read)POST /gists/{gist_id}/comments(read)GET /gists/{gist_id}/comments/{comment_id}(read)PATCH /gists/{gist_id}/comments/{comment_id}(read)DELETE /gists/{gist_id}/comments/{comment_id}(read)POST /gists(read)PATCH /gists/{gist_id}(read)DELETE /gists/{gist_id}(read)POST /gists/{gist_id}/forks(read)PUT /gists/{gist_id}/star(read)DELETE /gists/{gist_id}/star(read)GET /notifications(read)GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}(read)PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}(read)DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}(read)GET /repos/{owner}/{repo}/comments/{comment_id}/reactions(read)GET /orgs/{org}/repos(read) {% ifversion fpt or ghec or ghes %}-GET /repositories(read){% endif %}GET /repos/{owner}/{repo}(read)GET /repos/{owner}/{repo}/contributors(read)GET /repos/{owner}/{repo}/forks(read)GET /repos/{owner}/{repo}/languages(read)GET /repos/{owner}/{repo}/tags(read)GET /users/{username}/repos(read)GET /user/repos(read)GET /repos/{owner}/{repo}/stargazers(read)GET /repos/{owner}/{repo}/subscribers(read)GET /repos/{owner}/{repo}/collaborators(read)GET /repos/{owner}/{repo}/collaborators/{username}(read)GET /repos/{owner}/{repo}/collaborators/{username}/permission(read)GET /repos/{owner}/{repo}/comments(read)GET /repos/{owner}/{repo}/comments/{comment_id}(read)GET /repos/{owner}/{repo}/license(read)GET /repos/{owner}/{repo}/stats/code_frequency(read)GET /repos/{owner}/{repo}/stats/commit_activity(read)GET /repos/{owner}/{repo}/stats/contributors(read)GET /repos/{owner}/{repo}/stats/participation(read)GET /repos/{owner}/{repo}/stats/punch_card(read)GET /search/labels(read)GET /repos/{owner}/{repo}/topics(read)
Notifications
GET /notifications(read)
Organization administration
{% ifversion ghec or ghae or ghes %}- GET /orgs/{org}/audit-log (read){% endif %}
{% ifversion fpt or ghec %}- GET /orgs/{org}/settings/billing/actions (read){% endif %}
{% ifversion fpt or ghec or ghes > 3.3 %}- GET /orgs/{org}/settings/billing/advanced-security (read){% endif %}
{% ifversion fpt or ghec %}- GET /orgs/{org}/settings/billing/packages (read){% endif %}
{% ifversion fpt or ghec %}- GET /orgs/{org}/settings/billing/shared-storage (read){% endif %}
{% ifversion fpt or ghec %}- GET /enterprise-installation/{enterprise_or_org}/server-statistics (read){% endif %}
{% ifversion fpt or ghec %}- GET /orgs/{org}/interaction-limits (read){% endif %}
{% ifversion fpt or ghec %}- PUT /orgs/{org}/interaction-limits (write){% endif %}
{% ifversion fpt or ghec %}- DELETE /orgs/{org}/interaction-limits (write){% endif %}
{% ifversion fpt or ghec or ghes > 3.4 %}- GET /orgs/{org}/actions/cache/usage (read){% endif %}
{% ifversion fpt or ghec or ghes > 3.4 %}- GET /orgs/{org}/actions/cache/usage-by-repository (read){% endif %}
GET /orgs/{org}/actions/permissions(read)PUT /orgs/{org}/actions/permissions(write)GET /orgs/{org}/actions/permissions/repositories(read)PUT /orgs/{org}/actions/permissions/repositories(write)GET /orgs/{org}/actions/permissions/selected-actions(read)PUT /orgs/{org}/actions/permissions/selected-actions(write) {% ifversion fpt or ghec or ghes > 3.4 %}-GET /orgs/{org}/actions/permissions/workflow(read){% endif %} {% ifversion fpt or ghec or ghes > 3.4 %}-PUT /orgs/{org}/actions/permissions/workflow(write){% endif %} {% ifversion fpt or ghec or ghes > 3.6 %}-GET /orgs/{org}/security-managers(read){% endif %} {% ifversion fpt or ghec or ghes > 3.6 %}-PUT /orgs/{org}/security-managers/teams/{team_slug}(write){% endif %} {% ifversion fpt or ghec or ghes > 3.6 %}-DELETE /orgs/{org}/security-managers/teams/{team_slug}(write){% endif %}PATCH /orgs/{org}(write)GET /orgs/{org}/installations(read)
{% ifversion fpt or ghec %}
Organization codespaces
GET /orgs/{org}/codespaces(read)
Organization codespaces secrets
GET /orgs/{org}/codespaces/secrets(read)GET /orgs/{org}/codespaces/secrets/{secret_name}(read)PUT /orgs/{org}/codespaces/secrets/{secret_name}(write)DELETE /orgs/{org}/codespaces/secrets/{secret_name}(write)GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories(read)PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories(write)GET /orgs/{org}/codespaces/secrets/public-key(read)
Organization codespaces settings
{% endif %}
{% ifversion fpt or ghec or ghes > 3.3 %}
Organization custom roles
GET /organizations/{organization_id}/custom_roles(read)GET /orgs/{org}/custom_roles/{role_id}(read)PATCH /orgs/{org}/custom_roles/{role_id}(write)DELETE /orgs/{org}/custom_roles/{role_id}(write)GET /orgs/{org}/fine_grained_permissions(read)
{% endif %}
{% ifversion fpt or ghec or ghes > 3.3 %}
Organization dependabot secrets
GET /orgs/{org}/dependabot/secrets(read)GET /orgs/{org}/dependabot/secrets/{secret_name}(read)PUT /orgs/{org}/dependabot/secrets/{secret_name}(write)DELETE /orgs/{org}/dependabot/secrets/{secret_name}(write)GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories(read)PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories(write)GET /orgs/{org}/dependabot/secrets/public-key(read)
{% endif %}
Organization events
Organization hooks
GET /orgs/{org}/hooks(read)POST /orgs/{org}/hooks(write)GET /orgs/{org}/hooks/{hook_id}(read)PATCH /orgs/{org}/hooks/{hook_id}(write)DELETE /orgs/{org}/hooks/{hook_id}(write)GET /orgs/{org}/hooks/{hook_id}/config(read)PATCH /orgs/{org}/hooks/{hook_id}/config(write)GET /orgs/{org}/hooks/{hook_id}/deliveries(read)GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}(read)POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts(write)POST /orgs/{org}/hooks/{hook_id}/pings(write)
{% ifversion ghes %}
Organization pre receive hooks
GET /orgs/{org}/pre-receive-hooks(read)GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}(read)PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}(write)DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}(write)
{% endif %}
Organization projects
PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}(admin)DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}(admin)GET /orgs/{org}/projects(read)POST /orgs/{org}/projects(write)
Organization secrets
GET /orgs/{org}/actions/secrets(read)GET /orgs/{org}/actions/secrets/{secret_name}(read)PUT /orgs/{org}/actions/secrets/{secret_name}(write)DELETE /orgs/{org}/actions/secrets/{secret_name}(write)GET /orgs/{org}/actions/secrets/{secret_name}/repositories(read)PUT /orgs/{org}/actions/secrets/{secret_name}/repositories(write)GET /orgs/{org}/actions/secrets/public-key(read)
Organization self hosted runners
GET /orgs/{org}/actions/runner-groups(read)POST /orgs/{org}/actions/runner-groups(write)GET /orgs/{org}/actions/runner-groups/{runner_group_id}(read)PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}(write)DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}(write) {% ifversion fpt or ghec or ghes %}-GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories(read){% endif %} {% ifversion fpt or ghec or ghes %}-PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories(write){% endif %} {% ifversion fpt or ghec or ghes %}-GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners(read){% endif %} {% ifversion fpt or ghec or ghes %}-PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners(write){% endif %}PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}(write) {% ifversion fpt or ghec or ghes %}-DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}(write){% endif %}GET /orgs/{org}/actions/runners(read)GET /orgs/{org}/actions/runners/{runner_id}(read)DELETE /orgs/{org}/actions/runners/{runner_id}(write) {% ifversion fpt or ghec or ghes > 3.3 %}-GET /orgs/{org}/actions/runners/{runner_id}/labels(read){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-POST /orgs/{org}/actions/runners/{runner_id}/labels(write){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-PUT /orgs/{org}/actions/runners/{runner_id}/labels(write){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-DELETE /orgs/{org}/actions/runners/{runner_id}/labels(write){% endif %} {% ifversion fpt or ghec or ghes > 3.3 %}-DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}(write){% endif %}GET /orgs/{org}/actions/runners/downloads(read)POST /orgs/{org}/actions/runners/registration-token(write)POST /orgs/{org}/actions/runners/remove-token(write)
{% ifversion fpt or ghec %}
Organization user blocking
GET /orgs/{org}/blocks(read)GET /orgs/{org}/blocks/{username}(read)PUT /orgs/{org}/blocks/{username}(write)DELETE /orgs/{org}/blocks/{username}(write)
{% endif %}
Pages
GET /repos/{owner}/{repo}/pages(read)PUT /repos/{owner}/{repo}/pages(write)GET /repos/{owner}/{repo}/pages/builds(read)POST /repos/{owner}/{repo}/pages/builds(write)GET /repos/{owner}/{repo}/pages/builds/{build_id}(read)GET /repos/{owner}/{repo}/pages/builds/latest(read) {% ifversion fpt or ghec or ghes > 3.6 %}-POST /repos/{owner}/{repo}/pages/deployment(write){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/pages/health(write){% endif %}
{% ifversion fpt or ghec %}
Plan
GET /users/{username}/settings/billing/actions(read)GET /users/{username}/settings/billing/packages(read)GET /users/{username}/settings/billing/shared-storage(read)
{% endif %}
Profile
PATCH /user(write)
Pull requests
GET /repos/{owner}/{repo}/pulls/{pull_number}/comments(read)POST /repos/{owner}/{repo}/pulls/{pull_number}/comments(write)GET /repos/{owner}/{repo}/pulls/comments(read)GET /repos/{owner}/{repo}/pulls/comments/{comment_id}(read)PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}(write)DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}(write)PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals(write)POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events(write)GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers(read)POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers(write)DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers(write)GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews(read)POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews(write)GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}(read)PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}(write)DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}(write)GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments(read)GET /repos/{owner}/{repo}/pulls(read)POST /repos/{owner}/{repo}/pulls(write)GET /repos/{owner}/{repo}/pulls/{pull_number}(read)PATCH /repos/{owner}/{repo}/pulls/{pull_number}(write)GET /repos/{owner}/{repo}/pulls/{pull_number}/commits(read)GET /repos/{owner}/{repo}/pulls/{pull_number}/files(read)GET /repos/{owner}/{repo}/pulls/{pull_number}/merge(read)PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch(write)GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions(read)POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions(write)DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}(write) {% ifversion fpt or ghec or ghes > 3.5 %}-GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}(read){% endif %}
Repository hooks
GET /repos/{owner}/{repo}/hooks(read)POST /repos/{owner}/{repo}/hooks(write)GET /repos/{owner}/{repo}/hooks/{hook_id}(read)PATCH /repos/{owner}/{repo}/hooks/{hook_id}(write)DELETE /repos/{owner}/{repo}/hooks/{hook_id}(write)GET /repos/{owner}/{repo}/hooks/{hook_id}/config(read)PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config(write)GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries(read)GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}(read)POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts(write)POST /repos/{owner}/{repo}/hooks/{hook_id}/pings(read)POST /repos/{owner}/{repo}/hooks/{hook_id}/tests(read)
{% ifversion ghes %}
Repository pre receive hooks
GET /repos/{owner}/{repo}/pre-receive-hooks(read)GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}(read)PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}(write)DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}(write)
{% endif %}
Repository projects
GET /projects/{project_id}/collaborators(write)PUT /projects/{project_id}/collaborators/{username}(write)DELETE /projects/{project_id}/collaborators/{username}(write)GET /projects/{project_id}/collaborators/{username}/permission(write)GET /projects/{project_id}(read)PATCH /projects/{project_id}(write)DELETE /projects/{project_id}(write)GET /projects/{project_id}/columns(read)POST /projects/{project_id}/columns(write)GET /projects/columns/{column_id}(read)PATCH /projects/columns/{column_id}(write)DELETE /projects/columns/{column_id}(write)GET /projects/columns/{column_id}/cards(read)POST /projects/columns/{column_id}/cards(write)POST /projects/columns/{column_id}/moves(write)GET /projects/columns/cards/{card_id}(read)PATCH /projects/columns/cards/{card_id}(write)DELETE /projects/columns/cards/{card_id}(write)POST /projects/columns/cards/{card_id}/moves(write)GET /repos/{owner}/{repo}/projects(read)POST /repos/{owner}/{repo}/projects(write)
Secret scanning alerts
{% ifversion fpt or ghec or ghes %}- GET /orgs/{org}/secret-scanning/alerts (read){% endif %}
GET /repos/{owner}/{repo}/secret-scanning/alerts(read)GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}(read)PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}(write)GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations(read)
Secrets
GET /repos/{owner}/{repo}/actions/secrets(read)GET /repos/{owner}/{repo}/actions/secrets/{secret_name}(read)PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}(write)DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}(write)GET /repos/{owner}/{repo}/actions/secrets/public-key(read)
Security events
{% ifversion fpt or ghec or ghae or ghes > 3.4 %}- GET /orgs/{org}/code-scanning/alerts (read){% endif %}
GET /repos/{owner}/{repo}/code-scanning/alerts(read)GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}(read)PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}(write)GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances(read)GET /repos/{owner}/{repo}/code-scanning/analyses(read)GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}(read)DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}(write)GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}(read)POST /repos/{owner}/{repo}/code-scanning/sarifs(write) {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/dependabot/alerts(read){% endif %} {% ifversion fpt or ghec %}-GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}(read){% endif %} {% ifversion fpt or ghec %}-PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}(write){% endif %}
Starring
GET /users/{username}/starred(read)GET /user/starred(read)GET /user/starred/{owner}/{repo}(read)PUT /user/starred/{owner}/{repo}(write)DELETE /user/starred/{owner}/{repo}(write)
Statuses
Team discussions
GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions(read)POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions(write)DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}(write)GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions(read)POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions(write)DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}(write)GET /orgs/{org}/teams/{team_slug}/discussions(read)POST /orgs/{org}/teams/{team_slug}/discussions(write)GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}(read)PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}(write)DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}(write)GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments(read)POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments(write)GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}(read)PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}(write)DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}(write)
{% ifversion fpt or ghec %}
Vulnerability alerts
{% endif %}
Watching
GET /users/{username}/subscriptions(read)GET /user/subscriptions(read)