用于阻止用户的 REST API 端点
使用 REST API 管理被阻止的用户。
关于阻止用户
如果请求 URL 未包含 {username} 参数，则响应将针对登录的用户（并且您必须将 身份验证信息 与您的请求一起传递）。使用具有 user 范围的 OAuth 进行身份验证时，将包含其他私有信息，例如用户是否启用了双因素身份验证。
列出经过身份验证的用户阻止的用户
列出您在个人帐户中阻止的用户。
“列出经过身份验证的用户阻止的用户”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “阻止其他用户”用户权限（读取）
“列出经过身份验证的用户阻止的用户”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
per_page 整数每页结果数（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。 默认值： |
page 整数要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。 默认值： |
“列出经过身份验证的用户阻止的用户”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | 确定 |
304 | 未修改 |
401 | 需要身份验证 |
403 | 禁止 |
404 | 资源未找到 |
“列出经过身份验证的用户阻止的用户”的代码示例
请求示例
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/blocks响应
状态：200[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]检查经过身份验证的用户是否阻止了某个用户
如果经过身份验证的用户阻止了给定用户，则返回 204。如果经过身份验证的用户未阻止给定用户，或者如果给定用户帐户已被 GitHub 识别为垃圾邮件，则返回 404。
“检查经过身份验证的用户是否阻止了某个用户”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “阻止其他用户”用户权限（读取）
“检查经过身份验证的用户是否阻止了某个用户”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
username 字符串 必需GitHub 用户帐户的句柄。 |
“检查经过身份验证的用户是否阻止了某个用户”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
204 | 如果用户被阻止 |
304 | 未修改 |
401 | 需要身份验证 |
403 | 禁止 |
404 | 如果用户未被阻止 |
“检查经过身份验证的用户是否阻止了某个用户”的代码示例
请求示例
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/blocks/USERNAME如果用户被阻止
状态：204阻止用户
阻止给定用户并返回 204。如果经过身份验证的用户无法阻止给定用户，则返回 422。
“阻止用户”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “阻止其他用户”用户权限（写入）
“阻止用户”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
username 字符串 必需GitHub 用户帐户的句柄。 |
“阻止用户”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
204 | 无内容 |
304 | 未修改 |
401 | 需要身份验证 |
403 | 禁止 |
404 | 资源未找到 |
422 | 验证失败或端点已被垃圾邮件发送。 |
“阻止用户”的代码示例
请求示例
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/blocks/USERNAME响应
状态：204取消阻止用户
取消阻止给定用户并返回 204。
“取消阻止用户”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “阻止其他用户”用户权限（写入）
“取消阻止用户”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
username 字符串 必需GitHub 用户帐户的句柄。 |
“取消阻止用户”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
204 | 无内容 |
304 | 未修改 |
401 | 需要身份验证 |
403 | 禁止 |
404 | 资源未找到 |
“取消阻止用户”的代码示例
请求示例
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/blocks/USERNAME响应
状态：204