Blocage d’utilisateurs - Documentation GitHub

Utilisez l’API REST pour gérer les utilisateurs bloqués.

À propos du blocage d’utilisateurs

Si une URL de demande n’a pas de paramètre {username}, la réponse est destinée à l’utilisateur connecté (et vous devez transmettre les informations d’authentification avec votre demande). Des informations privées supplémentaires, par exemple si l’authentification à deux facteurs est activée pour un utilisateur, sont incluses lors de l’authentification par le biais d’OAuth avec l’étendue user.

List users blocked by the authenticated user

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

Paramètres pour « List users blocked by the authenticated user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de requête
Nom, Type, Description
`per_page` integer The number of results per page (max 100). Default: `30`
`page` integer Page number of the results to fetch. Default: `1`

Codes d’état de la réponse HTTP pour « List users blocked by the authenticated user »

Code d’état	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « List users blocked by the authenticated user »

get/user/blocks

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.

Paramètres pour « Check if a user is blocked by the authenticated user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`username` string Obligatoire The handle for the GitHub user account.

Codes d’état de la réponse HTTP pour « Check if a user is blocked by the authenticated user »

Code d’état	Description
`204`	If the user is blocked
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	If the user is not blocked

Exemples de code pour « Check if a user is blocked by the authenticated user »

get/user/blocks/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/blocks/USERNAME

If the user is blocked

Status: 204

Block a user

Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.

Paramètres pour « Block a user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`username` string Obligatoire The handle for the GitHub user account.

Codes d’état de la réponse HTTP pour « Block a user »

Code d’état	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour « Block a user »

put/user/blocks/{username}

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

Response

Status: 204

Unblock a user

Unblocks the given user and returns a 204.

Paramètres pour « Unblock a user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`username` string Obligatoire The handle for the GitHub user account.

Codes d’état de la réponse HTTP pour « Unblock a user »

Code d’état	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Unblock a user »

delete/user/blocks/{username}

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

Response

Status: 204