Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.
REST API теперь имеет версию. Дополнительные сведения см. в разделе Сведения об управлении версиями API.

Блокировка пользователей

Используйте REST API для блокировки и разблокировки пользователей в организации.

Сведения о блокировке пользователей

Маркер, используемый для проверки подлинности вызова, должен иметь область admin:org, чтобы выполнять любые блокирующие вызовы в организации. Иначе возвращается ответ HTTP 404.

List users blocked by an organization

Работа с GitHub Apps

List the users blocked by an organization.

Параметры для "List users blocked by an organization"

Заголовки
Имя, Тип, Описание
accept string

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

Параметры пути
Имя, Тип, Описание
org string Обязательно

The organization name. The name is not case sensitive.

Параметры запроса
Имя, Тип, Описание
per_page integer

The number of results per page (max 100).

По умолчанию: 30

page integer

Page number of the results to fetch.

По умолчанию: 1

Коды состояния HTTP-ответа для "List users blocked by an organization"

Код состоянияОписание
200

OK

Примеры кода для "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

Работа с GitHub Apps

Параметры для "Check if a user is blocked by an organization"

Заголовки
Имя, Тип, Описание
accept string

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

Параметры пути
Имя, Тип, Описание
org string Обязательно

The organization name. The name is not case sensitive.

username string Обязательно

The handle for the GitHub user account.

Коды состояния HTTP-ответа для "Check if a user is blocked by an organization"

Код состоянияОписание
204

If the user is blocked

404

If the user is not blocked

Примеры кода для "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

Работа с GitHub Apps

Параметры для "Block a user from an organization"

Заголовки
Имя, Тип, Описание
accept string

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

Параметры пути
Имя, Тип, Описание
org string Обязательно

The organization name. The name is not case sensitive.

username string Обязательно

The handle for the GitHub user account.

Коды состояния HTTP-ответа для "Block a user from an organization"

Код состоянияОписание
204

No Content

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "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

Работа с GitHub Apps

Параметры для "Unblock a user from an organization"

Заголовки
Имя, Тип, Описание
accept string

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

Параметры пути
Имя, Тип, Описание
org string Обязательно

The organization name. The name is not case sensitive.

username string Обязательно

The handle for the GitHub user account.

Коды состояния HTTP-ответа для "Unblock a user from an organization"

Код состоянияОписание
204

No Content

Примеры кода для "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