关于 GitHub App 权限
GitHub Apps 创建时会赋予一组权限。权限定义了 GitHub App 可以通过 API 访问哪些资源。更多信息,请参阅“为 GitHub App 选择权限”。
为了帮助您选择正确的权限,您将在 REST API 响应中收到 X-Accepted-GitHub-Permissions
头。此头将告诉您访问端点所需的权限。更多信息,请参阅“REST API 疑难解答”。
这些权限是访问私有资源所必需的。某些端点也可以在没有这些权限的情况下用于访问公共资源。要查看端点是否可以在没有权限的情况下访问公共资源,请参阅该端点的文档。
某些端点需要多个权限。其他端点可以使用一组权限中的任何一个权限。在这些情况下,“其他权限”列将包含一个复选标记。有关使用端点所需的权限的完整详细信息,请参阅该端点的文档。
“企业管理”的业务权限
“API Insights”的组织权限
“管理”的组织权限
“阻止用户”的组织权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
PUT /orgs/{org}/blocks/{username} | 写入 | UAT IAT | |
DELETE /orgs/{org}/blocks/{username} | 写入 | UAT IAT | |
GET /orgs/{org}/blocks | 读取 | UAT IAT | |
GET /orgs/{org}/blocks/{username} | 读取 | UAT IAT |
“自定义组织角色”的组织权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
GET /orgs/{org}/organization-roles | 读取 | UAT IAT | |
GET /orgs/{org}/organization-roles/{role_id} | 读取 | UAT IAT |
“自定义属性”的组织权限
“事件”的组织权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
GET /users/{username}/events/orgs/{org} | 读取 | UAT |
“GitHub Copilot Business”的组织权限
“成员”的组织权限
“组织 Codespaces 密钥”的组织权限
“组织 Codespaces 设置”的组织权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
PUT /orgs/{org}/codespaces/access | 写入 | UAT IAT | |
POST /orgs/{org}/codespaces/access/selected_users | 写入 | UAT IAT | |
DELETE /orgs/{org}/codespaces/access/selected_users | 写入 | UAT IAT |
“组织 Codespaces”的组织权限
“组织 Dependabot 密钥”的组织权限
组织对“个人访问令牌请求”的权限
组织对“个人访问令牌”的权限
组织对“项目”的权限
组织对“密钥”的权限
组织对“自托管运行器”的权限
组织对“团队讨论”的权限
组织对“变量”的权限
组织对“Webhooks”的权限
仓库对“Actions”的权限
仓库对“管理”的权限
仓库对“证明”的权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
POST /repos/{owner}/{repo}/attestations | 写入 | UAT IAT | |
GET /repos/{owner}/{repo}/attestations/{subject_digest} | 读取 | UAT IAT |
仓库对“检查”的权限
仓库对“代码扫描警报”的权限
仓库对“Codespaces 生命周期管理”的权限
仓库对“Codespaces 元数据”的权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
GET /repos/{owner}/{repo}/codespaces/devcontainers | 读取 | UAT IAT | |
GET /repos/{owner}/{repo}/codespaces/machines | 读取 | UAT IAT | |
GET /user/codespaces/{codespace_name}/machines | 读取 | UAT |
仓库对“Codespaces 密钥”的权限
仓库对“Codespaces”的权限
仓库对“提交状态”的权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
POST /repos/{owner}/{repo}/statuses/{sha} | 写入 | UAT IAT | |
GET /repos/{owner}/{repo}/commits/{ref}/status | 读取 | UAT IAT | |
GET /repos/{owner}/{repo}/commits/{ref}/statuses | 读取 | UAT IAT |
仓库对“内容”的权限
仓库对“Dependabot 警报”的权限
仓库对“Dependabot 密钥”的权限
仓库对“部署”的权限
仓库对“环境”的权限
仓库权限,“问题”
仓库权限,“元数据”
仓库权限,“Pages”
仓库权限,“项目”
仓库权限,“拉取请求”
仓库权限,“仓库安全公告”
仓库权限,“密钥扫描告警”
仓库权限,“密钥”
仓库权限,“变量”
仓库权限,“Webhooks”
仓库权限,“工作流”
用户权限,“屏蔽其他用户”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
PUT /user/blocks/{username} | 写入 | UAT | |
DELETE /user/blocks/{username} | 写入 | UAT | |
GET /user/blocks | 读取 | UAT | |
GET /user/blocks/{username} | 读取 | UAT |
用户权限,“Codespaces 用户密钥”
用户权限,“电子邮件地址”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
PATCH /user/email/visibility | 写入 | UAT | |
POST /user/emails | 写入 | UAT | |
DELETE /user/emails | 写入 | UAT | |
GET /user/emails | 读取 | UAT | |
GET /user/public_emails | 读取 | UAT |
用户权限,“关注者”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
PUT /user/following/{username} | 写入 | UAT | |
DELETE /user/following/{username} | 写入 | UAT | |
GET /user/followers | 读取 | UAT | |
GET /user/following | 读取 | UAT | |
GET /user/following/{username} | 读取 | UAT |
用户权限,“GPG 密钥”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
POST /user/gpg_keys | 写入 | UAT | |
DELETE /user/gpg_keys/{gpg_key_id} | 写入 | UAT | |
GET /user/gpg_keys | 读取 | UAT | |
GET /user/gpg_keys/{gpg_key_id} | 读取 | UAT |
用户权限,“Gists”
用户权限,“Git SSH 密钥”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
POST /user/keys | 写入 | UAT | |
DELETE /user/keys/{key_id} | 写入 | UAT | |
GET /user/keys | 读取 | UAT | |
GET /user/keys/{key_id} | 读取 | UAT | |
GET /users/{username}/keys | 读取 | UAT IAT |
用户权限,“交互限制”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
PUT /user/interaction-limits | 写入 | UAT | |
DELETE /user/interaction-limits | 写入 | UAT | |
GET /user/interaction-limits | 读取 | UAT |
用户权限,“套餐”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
GET /users/{username}/settings/billing/actions | 读取 | UAT | |
GET /users/{username}/settings/billing/packages | 读取 | UAT | |
GET /users/{username}/settings/billing/shared-storage | 读取 | UAT |
用户权限,“个人资料”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
PATCH /user | 写入 | UAT | |
POST /user/social_accounts | 写入 | UAT | |
DELETE /user/social_accounts | 写入 | UAT |
用户权限,“SSH 签名密钥”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
POST /user/ssh_signing_keys | 写入 | UAT | |
DELETE /user/ssh_signing_keys/{ssh_signing_key_id} | 写入 | UAT | |
GET /user/ssh_signing_keys | 读取 | UAT | |
GET /user/ssh_signing_keys/{ssh_signing_key_id} | 读取 | UAT |