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

适用于组织交互的 REST API 终结点

使用 REST API 临时限制哪类用户可以在组织的公共存储库上发表评论、开设问题或创建拉取请求。

关于组织交互

组织所有者可以临时限制哪类用户可在组织的公共存储库上发表评论、开设问题或创建拉取请求。 启用限制后,只有指定的 GitHub 用户类型才能参与交互。 限制在定义的期限后自动过期。 以下是有关 GitHub 用户类型的更多信息:

  • 组织中的 现有用户:将互动限制为 existing_users 时,帐户未满 24 小时且以前没有贡献且不是协作者的新用户将被暂时限制。
  • 组织中的 仅参与者:当你将交互限制为 contributors_only 时,以前未参与且不是协作者的用户将暂时受到限制。
  • 组织中的 仅协作者:将交互限制为 collaborators_only 时,非协作者用户将暂时受到限制。

在组织级别设置交互限制将覆盖为组织拥有的各个仓库设置的任何交互限制。 要为组织拥有的个别存储库设置不同的交互限制,请改为使用存储库交互终结点。

Get interaction restrictions for an organization

Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.

“Get interaction restrictions for an organization”的细粒度访问令牌

This endpoint works with the following fine-grained token types:

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

  • "Administration" organization permissions (read)

“Get interaction restrictions for an organization”的参数

标头
名称, 类型, 说明
accept string

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

路径参数
名称, 类型, 说明
org string 必须

The organization name. The name is not case sensitive.

“Get interaction restrictions for an organization”的 HTTP 响应状态代码

状态代码说明
200

OK

“Get interaction restrictions for an organization”的示例代码

请求示例

get/orgs/{org}/interaction-limits
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/interaction-limits

Response

Status: 200
{ "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" }

Set interaction restrictions for an organization

Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

“Set interaction restrictions for an organization”的细粒度访问令牌

This endpoint works with the following fine-grained token types:

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

  • "Administration" organization permissions (write)

“Set interaction restrictions for an organization”的参数

标头
名称, 类型, 说明
accept string

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

路径参数
名称, 类型, 说明
org string 必须

The organization name. The name is not case sensitive.

正文参数
名称, 类型, 说明
limit string 必须

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

可以是以下选项之一: existing_users, contributors_only, collaborators_only

expiry string

The duration of the interaction restriction. Default: one_day.

可以是以下选项之一: one_day, three_days, one_week, one_month, six_months

“Set interaction restrictions for an organization”的 HTTP 响应状态代码

状态代码说明
200

OK

422

Validation failed, or the endpoint has been spammed.

“Set interaction restrictions for an organization”的示例代码

请求示例

put/orgs/{org}/interaction-limits
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/interaction-limits \ -d '{"limit":"collaborators_only","expiry":"one_month"}'

Response

Status: 200
{ "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" }

Remove interaction restrictions for an organization

Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

“Remove interaction restrictions for an organization”的细粒度访问令牌

This endpoint works with the following fine-grained token types:

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

  • "Administration" organization permissions (write)

“Remove interaction restrictions for an organization”的参数

标头
名称, 类型, 说明
accept string

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

路径参数
名称, 类型, 说明
org string 必须

The organization name. The name is not case sensitive.

“Remove interaction restrictions for an organization”的 HTTP 响应状态代码

状态代码说明
204

No Content

“Remove interaction restrictions for an organization”的示例代码

请求示例

delete/orgs/{org}/interaction-limits
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/interaction-limits

Response

Status: 204