Skip to main content
REST API 现已经过版本控制。 有关详细信息,请参阅“关于 API 版本控制”。

用于阻止用户的 REST API 终结点

使用 REST API 阻止和取消阻止组织中的用户。

关于阻止用户

用于对调用进行身份验证的令牌必须具有 admin:org 范围才可对组织进行任何阻止调用。 否则,响应将返回 HTTP 404

List users blocked by an organization

List the users blocked by an organization.

“List users blocked by an organization”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • organization_user_blocking:read

“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). For more information, see "Using pagination in the REST API."

默认: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

默认: 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

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.

“Check if a user is blocked by an organization”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • organization_user_blocking:read

“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.

“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

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.

“Block a user from an organization”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • organization_user_blocking:write

“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.

“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

Unblocks the given user on behalf of the specified organization.

“Unblock a user from an organization”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • organization_user_blocking:write

“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.

“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