Skip to main content

Bloquear usuarios

El token que se utiliza para autenticar la llamada debe tener el alcance de admin:org para poder hacer cualquier llamada de bloqueo para una organización. De lo contrario, la respuesta devolverá un HTTP 404.

List users blocked by an organization

Funciona con GitHub Apps

List the users blocked by an organization.

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de ruta
Nombre, Tipo, Descripción
orgstringRequerido

The organization name. The name is not case sensitive.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

Ejemplos de código

get/orgs/{org}/blocks
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/orgs/ORG/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 an organization

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de ruta
Nombre, Tipo, Descripción
orgstringRequerido

The organization name. The name is not case sensitive.

usernamestringRequerido

The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

If the user is blocked:

404

If the user is not blocked:

Ejemplos de código

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

If the user is blocked:

Status: 204

Block a user from an organization

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de ruta
Nombre, Tipo, Descripción
orgstringRequerido

The organization name. The name is not case sensitive.

usernamestringRequerido

The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

No Content

422

Validation failed

Ejemplos de código

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

Response

Status: 204

Unblock a user from an organization

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de ruta
Nombre, Tipo, Descripción
orgstringRequerido

The organization name. The name is not case sensitive.

usernamestringRequerido

The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

No Content

Ejemplos de código

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

Response

Status: 204