Bloquear usuários
Use a API REST para bloquear e desbloquear os usuários em uma organização.
Sobre o bloqueio de usuários
O token usado para autenticar a chamada precisa ter o escopo admin:org
para fazer chamadas de bloqueio para uma organização. Caso contrário, a resposta retorna HTTP 404
.
List users blocked by an organization
List the users blocked by an organization.
Parâmetros para "List users blocked by an organization"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
org string ObrigatórioThe organization name. The name is not case sensitive. |
Parâmetros de consulta |
Name, Tipo, Descrição |
per_page integer The number of results per page (max 100). Padrão: |
page integer Page number of the results to fetch. Padrão: |
Códigos de status de resposta HTTP para "List users blocked by an organization"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "List users blocked by an organization"
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/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
Parâmetros para "Check if a user is blocked by an organization"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
org string ObrigatórioThe organization name. The name is not case sensitive. |
username string ObrigatórioThe handle for the GitHub user account. |
Códigos de status de resposta HTTP para "Check if a user is blocked by an organization"
Código de status | Descrição |
---|---|
204 | If the user is blocked |
404 | If the user is not blocked |
Exemplos de código para "Check if a user is blocked by an organization"
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/orgs/ORG/blocks/USERNAME
If the user is blocked
Status: 204
Block a user from an organization
Parâmetros para "Block a user from an organization"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
org string ObrigatórioThe organization name. The name is not case sensitive. |
username string ObrigatórioThe handle for the GitHub user account. |
Códigos de status de resposta HTTP para "Block a user from an organization"
Código de status | Descrição |
---|---|
204 | No Content |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Block a user from an organization"
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/orgs/ORG/blocks/USERNAME
Response
Status: 204
Unblock a user from an organization
Parâmetros para "Unblock a user from an organization"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
org string ObrigatórioThe organization name. The name is not case sensitive. |
username string ObrigatórioThe handle for the GitHub user account. |
Códigos de status de resposta HTTP para "Unblock a user from an organization"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "Unblock a user from an organization"
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/orgs/ORG/blocks/USERNAME
Response
Status: 204