Skip to main content

ユーザのブロック

Blocking users APIについて

Many of the resources on this API provide a shortcut for getting information about the currently authenticated user. リクエスト URL に {username} パラメータが含まれていない場合、レスポンスはログインしているユーザに対して行われます (リクエストで 認証情報 を渡す必要があります)。ユーザが 2 要素認証を有効にしているかなど、その他の個人情報は、基本認証または user スコープ付きで OAuth 認証されている場合に含まれます。

List users blocked by the authenticated user

List the users you've blocked on your personal account.

HTTP response status codes

Status code説明
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

コードサンプル

get/user/blocks
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

パラメータ

Headers
名前, 種類, 説明
acceptstring

Setting to application/vnd.github.v3+json is recommended.

Path parameters
名前, 種類, 説明
usernamestring必須

The handle for the GitHub user account.

HTTP response status codes

Status code説明
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.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/blocks/USERNAME

If the user is blocked:

Status: 204

Block a user

パラメータ

Headers
名前, 種類, 説明
acceptstring

Setting to application/vnd.github.v3+json is recommended.

Path parameters
名前, 種類, 説明
usernamestring必須

The handle for the GitHub user account.

HTTP response status codes

Status code説明
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed

コードサンプル

put/user/blocks/{username}
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

パラメータ

Headers
名前, 種類, 説明
acceptstring

Setting to application/vnd.github.v3+json is recommended.

Path parameters
名前, 種類, 説明
usernamestring必須

The handle for the GitHub user account.

HTTP response status codes

Status code説明
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.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/blocks/USERNAME

Response

Status: 204