阻止用户
关于阻止用户 API
Many of the resources on this API provide a shortcut for getting information about the currently authenticated user. 如果请求 URL 不含 {username}
参数,则响应将是登录用户的响应(您必须随请求传递身份验证信息)。 在通过基本身份验证或作用域为 user
的 OAuth 进行身份验证时,将包含其他私有信息,例如用户是否启用双重身份验证。
List users blocked by the authenticated user
List the users you've blocked on your personal account.
HTTP 响应状态代码
状态代码 | 描述 |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
代码示例
curl \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
https://api.github.com/user/blocks
Response
Status: 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
}
]
Check if a user is blocked by the authenticated user
参数
标头 |
---|
名称, 类型, 描述 |
accept stringSetting to |
路径参数 |
名称, 类型, 描述 |
username string必选The handle for the GitHub user account. |
HTTP 响应状态代码
状态代码 | 描述 |
---|---|
204 | If the user is blocked: |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | If the user is not blocked: |
代码示例
curl \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
https://api.github.com/user/blocks/USERNAME
If the user is blocked:
Status: 204
Block a user
参数
标头 |
---|
名称, 类型, 描述 |
accept stringSetting to |
路径参数 |
名称, 类型, 描述 |
username string必选The handle for the GitHub user account. |
HTTP 响应状态代码
状态代码 | 描述 |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed |
代码示例
curl \
-X PUT \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
https://api.github.com/user/blocks/USERNAME
Response
Status: 204
Unblock a user
参数
标头 |
---|
名称, 类型, 描述 |
accept stringSetting to |
路径参数 |
名称, 类型, 描述 |
username string必选The handle for the GitHub user account. |
HTTP 响应状态代码
状态代码 | 描述 |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
代码示例
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
https://api.github.com/user/blocks/USERNAME
Response
Status: 204