Permissions required for GitHub Apps

You can find the required permissions for each GitHub 应用程序-compatible endpoint.

About GitHub 应用程序 permissions

GitHub 应用程序 are created with a set of permissions. Permissions define what resources the GitHub 应用程序 can access via the API. For more information, see "Setting permissions for GitHub Apps."

Metadata permissions

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

如果将元数据权限设置为 No access 并选择需要访问仓库的权限,GitHub 将覆盖您的选择并将元数据权限设回 Read-only。 要将元数据权限设置为 No access,必须先将需要访问仓库的所有权限设置为 No access

Collaborators

Commit comments

Events

Git

Keys

Organization members

Search

Permission on "actions"

Permission on "administration"

Branches

Collaborators

Invitations

Keys

Teams

Permission on "checks"

Permission on "contents"

Branches

Commit comments

Git

Reactions

Releases

Permission on "deployments"

Permission on "emails"

Permission on "followers"

Permission on "gpg keys"

Permission on "issues"

Issues and pull requests are closely related. For more information, see "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.

Assignees

Events

Labels

Milestones

Reactions

Permission on "keys"

Keys

Permission on "members"

Organization members

Team members

Teams

Permission on "organization administration"

Permission on "organization events"

Permission on "organization hooks"

Teams

Permission on "organization pre receive hooks"

Permission on "organization projects"

Permission on "pages"

Permission on "pull requests"

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

Assignees

Events

Labels

Milestones

Reactions

Requested reviewers

Reviews

Permission on "profile"

Permission on "repository hooks"

Permission on "repository pre receive hooks"

Permission on "repository projects"

Teams

Permission on "secret scanning alerts"

Permission on "security events"

Permission on "self-hosted runners"

Permission on "single file"

Permission on "starring"

Permission on "statuses"

Permission on "team discussions"

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。