Puntos de conexión de API de REST para bloquear usuarios
La API de REST permite administrar usuarios bloqueados.
Acerca de bloquear usuarios
Si una dirección URL de solicitud no incluye un parámetro {username}
, la respuesta será para el usuario que ha iniciado sesión (y debe pasar la información de autenticación con la solicitud). Información privada adicional, como si un usuario tiene habilitada la autenticación en dos fases, se incluye cuando se autentica a través de OAuth con el ámbito user
.
List users blocked by the authenticated user
List the users you've blocked on your personal account.
Tokens de acceso específicos para "List users blocked by the authenticated user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Block another user" user permissions (read)
Parámetros para "List users blocked by the authenticated user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
Códigos de estado de respuesta HTTP para "List users blocked by the authenticated user"
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "List users blocked by the authenticated user"
Si accedes a GitHub en GHE.com, reemplaza api.github.com
por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Check if a user is blocked by the authenticated user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Block another user" user permissions (read)
Parámetros para "Check if a user is blocked by the authenticated user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
username string RequeridoThe handle for the GitHub user account. |
Códigos de estado de respuesta HTTP para "Check if a user is blocked by the authenticated user"
status code | Descripción |
---|---|
204 | If the user is blocked |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | If the user is not blocked |
Ejemplos de código para "Check if a user is blocked by the authenticated user"
Si accedes a GitHub en GHE.com, reemplaza api.github.com
por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Block a user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Block another user" user permissions (write)
Parámetros para "Block a user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
username string RequeridoThe handle for the GitHub user account. |
Códigos de estado de respuesta HTTP para "Block a user"
status code | Descripción |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Ejemplos de código para "Block a user"
Si accedes a GitHub en GHE.com, reemplaza api.github.com
por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Unblock a user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Block another user" user permissions (write)
Parámetros para "Unblock a user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
username string RequeridoThe handle for the GitHub user account. |
Códigos de estado de respuesta HTTP para "Unblock a user"
status code | Descripción |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Unblock a user"
Si accedes a GitHub en GHE.com, reemplaza api.github.com
por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com
.
Ejemplo de solicitud
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