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”的参数

标头
名称, 类型, 说明
acceptstring

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

路径参数
名称, 类型, 说明
orgstring必选

The organization name. The name is not case sensitive.

查询参数
名称, 类型, 说明
per_pageinteger

The number of results per page (max 100).

默认: 30

pageinteger

Page number of the results to fetch.

默认: 1

“List users blocked by an organization”的 HTTP 响应状态代码

状态代码说明
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”的参数

标头
名称, 类型, 说明
acceptstring

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

路径参数
名称, 类型, 说明
orgstring必选

The organization name. The name is not case sensitive.

usernamestring必选

The handle for the GitHub user account.

“Check if a user is blocked by an organization”的 HTTP 响应状态代码

状态代码说明
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”的参数

标头
名称, 类型, 说明
acceptstring

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

路径参数
名称, 类型, 说明
orgstring必选

The organization name. The name is not case sensitive.

usernamestring必选

The handle for the GitHub user account.

“Block a user from an organization”的 HTTP 响应状态代码

状态代码说明
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”的参数

标头
名称, 类型, 说明
acceptstring

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

路径参数
名称, 类型, 说明
orgstring必选

The organization name. The name is not case sensitive.

usernamestring必选

The handle for the GitHub user account.

“Unblock a user from an organization”的 HTTP 响应状态代码

状态代码说明
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