Points de terminaison d’API REST pour bloquer les utilisateurs
Utilisez l’API REST pour bloquer et débloquer des utilisateurs dans une organisation.
À propos du blocage d’utilisateurs
Le jeton utilisé pour authentifier l’appel doit avoir l’étendue admin:org
pour effectuer des appels bloquants pour une organisation. Sinon, la réponse retourne HTTP 404
.
List users blocked by an organization
List the users blocked by an organization.
Jetons d’accès affinés pour « List users blocked by an organization »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Blocking users" organization permissions (read)
Paramètres pour « List users blocked by an organization »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
Nom, Type, Description |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
Codes d’état de la réponse HTTP pour « List users blocked by an organization »
Code d’état | Description |
---|---|
200 | OK |
Exemples de code pour « List users blocked by an organization »
Exemple de requête
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
Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.
Jetons d’accès affinés pour « Check if a user is blocked by an organization »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Blocking users" organization permissions (read)
Paramètres pour « Check if a user is blocked by an organization »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
username string ObligatoireThe handle for the GitHub user account. |
Codes d’état de la réponse HTTP pour « Check if a user is blocked by an organization »
Code d’état | Description |
---|---|
204 | If the user is blocked |
404 | If the user is not blocked |
Exemples de code pour « Check if a user is blocked by an organization »
Exemple de requête
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
Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
Jetons d’accès affinés pour « Block a user from an organization »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Blocking users" organization permissions (write)
Paramètres pour « Block a user from an organization »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
username string ObligatoireThe handle for the GitHub user account. |
Codes d’état de la réponse HTTP pour « Block a user from an organization »
Code d’état | Description |
---|---|
204 | No Content |
422 | Validation failed, or the endpoint has been spammed. |
Exemples de code pour « Block a user from an organization »
Exemple de requête
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
Unblocks the given user on behalf of the specified organization.
Jetons d’accès affinés pour « Unblock a user from an organization »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Blocking users" organization permissions (write)
Paramètres pour « Unblock a user from an organization »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
username string ObligatoireThe handle for the GitHub user account. |
Codes d’état de la réponse HTTP pour « Unblock a user from an organization »
Code d’état | Description |
---|---|
204 | No Content |
Exemples de code pour « Unblock a user from an organization »
Exemple de requête
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