Skip to main content

ユーザのブロック

ユーザーのブロック API について

この API のリソースの多くには、現在認証されているユーザーについての情報を取得するためのショートカットがあります。 要求 URL に {username} パラメーターが含まれていない場合、応答はログインしているユーザーに対して行われます (要求で認証情報を渡す必要があります)。 ユーザーが 2 要素認証を有効にしているかどうかなど、追加の個人情報は、基本認証または user スコープを使用して OAuth で認証されるときに含まれます。

List users blocked by the authenticated user

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

HTTP 応答状態コード

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+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
acceptstring

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

Path parameters
Name, Type, Description
usernamestringRequired

The handle for the GitHub user account.

HTTP 応答状態コード

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+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
acceptstring

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

Path parameters
Name, Type, Description
usernamestringRequired

The handle for the GitHub user account.

HTTP 応答状態コード

status code説明
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
acceptstring

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

Path parameters
Name, Type, Description
usernamestringRequired

The handle for the GitHub user account.

HTTP 応答状態コード

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+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://api.github.com/user/blocks/USERNAME

Response

Status: 204