REST API 现在已版本化。 有关更多信息，请参阅 "关于 API 版本控制."
阻止用户的 REST API 端点
使用 REST API 在组织中阻止和解除阻止用户。
关于阻止用户
用于验证调用的令牌必须具有admin:org 范围才能对组织进行任何阻止调用。否则，响应将返回HTTP 404。
列出组织阻止的用户
列出组织阻止的用户。
“列出组织阻止的用户”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- “阻止用户”组织权限（读取）
“列出组织阻止的用户”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
org string 必需组织名称。名称不区分大小写。 |
| 名称、类型、描述 |
|---|
per_page integer 每页结果数（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。 默认: |
page integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。 默认: |
“列出组织阻止的用户”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
“列出组织阻止的用户”的代码示例
请求示例
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响应
状态：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 } ]检查用户是否被组织封禁
如果给定用户被给定组织封禁，则返回 204。如果组织没有封禁用户，或者用户帐户被 GitHub 识别为垃圾邮件，则返回 404。
用于“检查用户是否被组织封禁”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- “阻止用户”组织权限（读取）
用于“检查用户是否被组织封禁”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
org string 必需组织名称。名称不区分大小写。 |
username string 必需GitHub 用户帐户的句柄。 |
用于“检查用户是否被组织封禁”的 HTTP 响应状态码
| 状态代码 | 描述 |
|---|---|
204 | 如果用户被封禁 |
404 | 如果用户未被封禁 |
用于“检查用户是否被组织封禁”的代码示例
请求示例
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如果用户被封禁
状态: 204将用户从组织中屏蔽
代表指定的组织屏蔽给定的用户，并返回 204。如果组织无法屏蔽给定的用户，则返回 422。
用于“将用户从组织中屏蔽”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- “屏蔽用户”组织权限（写入）
“将用户从组织中屏蔽”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
org string 必需组织名称。名称不区分大小写。 |
username string 必需GitHub 用户帐户的句柄。 |
“将用户从组织中屏蔽”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
204 | 无内容 |
422 | 验证失败，或端点已被垃圾邮件。 |
“将用户从组织中屏蔽”的代码示例
请求示例
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响应
状态: 204从组织中解除屏蔽用户
代表指定的组织解除屏蔽给定的用户。
用于“从组织中解除屏蔽用户”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- “屏蔽用户”组织权限（写入）
“从组织中解除屏蔽用户”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
org string 必需组织名称。名称不区分大小写。 |
username string 必需GitHub 用户帐户的句柄。 |
“从组织中解除屏蔽用户”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
204 | 无内容 |
“从组织中解除屏蔽用户”的代码示例
请求示例
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响应
状态: 204