阻止用户 - GitHub Docs

阻止用户

关于阻止用户 API

此 API 上的许多资源提供了快捷方式，可用于获取有关当前经过身份验证的用户的信息。如果请求 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

代码示例

get/user/blocks

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`username`stringRequired 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

代码示例

get/user/blocks/{username}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/user/blocks/USERNAME

If the user is blocked

Status: 204

Block a user

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`username`stringRequired 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, or the endpoint has been spammed.

代码示例

put/user/blocks/{username}

curl \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/user/blocks/USERNAME

Response

Status: 204

Unblock a user

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`username`stringRequired The handle for the GitHub user account.

HTTP 响应状态代码

状态代码	说明
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

代码示例

delete/user/blocks/{username}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/user/blocks/USERNAME

Response

Status: 204