Skip to main content

Bloquear usuários

Sobre a API Bloqueio de usuários

Many of the resources on this API provide a shortcut for getting information about the currently authenticated user. Se uma URL de solicitação não incluir um parâmetro {username}, a resposta será para o usuário conectado (e você deve passar informações de autenticação com sua solicitação). Informações privadas adicionais, como se um usuário tem autenticação de dois fatores habilitada, estão incluídas quando a autenticação é efetuada por meio da autenticação básica ou OAuth com o escopo do usuário .

List users blocked by the authenticated user

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

HTTP response status codes

Status codeDescrição
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Amostras de código

get/user/blocks
curl \ -H "Accept: application/vnd.github+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

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
usernamestringObrigatório

The handle for the GitHub user account.

HTTP response status codes

Status codeDescrição
204

If the user is blocked:

304

Not modified

401

Requires authentication

403

Forbidden

404

If the user is not blocked:

Amostras de código

get/user/blocks/{username}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/blocks/USERNAME

If the user is blocked:

Status: 204

Block a user

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
usernamestringObrigatório

The handle for the GitHub user account.

HTTP response status codes

Status codeDescrição
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed

Amostras de código

put/user/blocks/{username}
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/blocks/USERNAME

Response

Status: 204

Unblock a user

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
usernamestringObrigatório

The handle for the GitHub user account.

HTTP response status codes

Status codeDescrição
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

Amostras de código

delete/user/blocks/{username}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/blocks/USERNAME

Response

Status: 204