Blockieren von Benutzern

Verwende die REST-API, um Benutzer in einer Organisation zu blockieren und die Blockierung aufzuheben.

Informationen zum Blockieren von Benutzern

Das Token, das zum Authentifizieren des Aufrufs verwendet wird, muss den admin:org-Bereich aufweisen, um blockierender Aufrufe für eine Organisation vorzunehmen. Andernfalls gibt die Antwort HTTP 404 zurück.

List users blocked by an organization

Funktioniert mit GitHub Apps

List the users blocked by an organization.

Parameter für „List users blocked by an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). Standard: `30`
`page` integer Page number of the results to fetch. Standard: `1`

HTTP-Antwortstatuscodes für „List users blocked by an organization“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List users blocked by an organization“

get/orgs/{org}/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/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

Funktioniert mit GitHub Apps

Parameter für „Check if a user is blocked by an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Check if a user is blocked by an organization“

Statuscode	BESCHREIBUNG
`204`	If the user is blocked
`404`	If the user is not blocked

Codebeispiele für „Check if a user is blocked by an organization“

get/orgs/{org}/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/orgs/ORG/blocks/USERNAME

If the user is blocked

Status: 204

Block a user from an organization

Funktioniert mit GitHub Apps

Parameter für „Block a user from an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Block a user from an organization“

Statuscode	BESCHREIBUNG
`204`	No Content
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „Block a user from an organization“

put/orgs/{org}/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/orgs/ORG/blocks/USERNAME

Response

Status: 204

Unblock a user from an organization

Funktioniert mit GitHub Apps

Parameter für „Unblock a user from an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Unblock a user from an organization“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Unblock a user from an organization“

delete/orgs/{org}/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/orgs/ORG/blocks/USERNAME

Response

Status: 204