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

Works with GitHub Apps

List the users blocked by an organization.

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`org`stringRequired The organization name. The name is not case sensitive.
Query parameters
Name, Type, BESCHREIBUNG
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	BESCHREIBUNG
`200`	OK

Code samples

get/orgs/{org}/blocks

curl \
  -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

Works with GitHub Apps

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`org`stringRequired The organization name. The name is not case sensitive.
`username`stringRequired The handle for the GitHub user account.

HTTP response status codes

Status code	BESCHREIBUNG
`204`	If the user is blocked
`404`	If the user is not blocked

Code samples

get/orgs/{org}/blocks/{username}

curl \
  -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

Works with GitHub Apps

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`org`stringRequired The organization name. The name is not case sensitive.
`username`stringRequired The handle for the GitHub user account.

HTTP response status codes

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

Code samples

put/orgs/{org}/blocks/{username}

curl \
  -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

Works with GitHub Apps

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`org`stringRequired The organization name. The name is not case sensitive.
`username`stringRequired The handle for the GitHub user account.

HTTP response status codes

Status code	BESCHREIBUNG
`204`	No Content

Code samples

delete/orgs/{org}/blocks/{username}

curl \
  -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