关于 GitHub App 权限
GitHub App 是使用一组权限创建的。权限定义了 GitHub App 可以通过 API 访问哪些资源。有关更多信息,请参阅“为 GitHub App 选择权限”。
为了帮助您选择正确的权限,您将在 REST API 响应中收到 X-Accepted-GitHub-Permissions
标头。该标头将告诉您为了访问端点需要哪些权限。有关更多信息,请参阅“REST API 故障排除”。
这些权限是访问私有资源所必需的。某些端点也可以在没有这些权限的情况下用于访问公共资源。要查看端点是否可以在没有权限的情况下访问公共资源,请参阅该端点的文档。
某些端点需要多个权限。其他端点可以使用一组权限中的任何一个权限。在这些情况下,“其他权限”列将包含一个复选标记。有关使用端点所需的权限的完整详细信息,请参阅该端点的文档。
“企业管理”的企业权限
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
GET /enterprises/{enterprise}/copilot/usage | 读取 | ||
GET /orgs/{org}/copilot/usage | 读取 | UAT IAT | 需要多个权限,或者可以使用其他权限。有关权限的更多信息,请参阅此端点的文档。 |
组织权限“管理”
组织权限“阻止用户”
端点 | 访问 | 令牌类型 | 其他权限 |
---|---|---|---|
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 /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 密钥”的权限
组织对“个人访问令牌请求”的权限
组织对“个人访问令牌”的权限
组织对“项目”的权限
组织对“Secrets”的权限
组织对“自托管运行器”的权限
组织对“团队讨论”的权限
组织对“变量”的权限
组织对“Webhooks”的权限
仓库对“Actions”的权限
仓库“管理”权限
仓库“检查”权限
代码扫描警报的仓库权限
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”
仓库权限“Projects”
仓库权限“Pull requests”
仓库对“仓库安全建议”的权限
仓库对“秘密扫描警报”的权限
仓库对“秘密”的权限
仓库对“变量”的权限
仓库对“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 |