用于屏蔽用户的 REST API 端点
使用 REST API 管理屏蔽的用户。
关于屏蔽用户
如果请求 URL 中不包含 {username} 参数，则响应将针对已登录的用户（并且您必须通过请求传递 身份验证信息）。当通过 OAuth 身份验证并使用 user 范围时，将包含其他私人信息，例如用户是否启用了双因素身份验证。
列出被认证用户屏蔽的用户
列出您在个人帐户中屏蔽的用户。
用于“列出被认证用户屏蔽的用户”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- “屏蔽其他用户”用户权限（读取）
用于“列出被认证用户屏蔽的用户”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
per_page integer 每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页." 默认: |
page integer 要获取的结果页码。有关更多信息，请参阅 "在 REST API 中使用分页." 默认: |
用于“列出被认证用户屏蔽的用户”的 HTTP 响应状态码
| 状态码 | 描述 |
|---|---|
200 | OK |
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 string 建议设置为 |
| 名称、类型、描述 |
|---|
username string 必需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 string 建议设置为 |
| 名称、类型、描述 |
|---|
username string 必需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 string 建议设置为 |
| 名称、类型、描述 |
|---|
username string 必需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