Skip to main content

组织交互

组织交互 API 允许组织所有者临时限制哪类用户可以在组织的公共仓库中发表评论、开设议题或创建拉取请求。

关于组织交互 API

组织交互 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.

参数

标头
名称, 类型, 描述
acceptstring

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

路径参数
名称, 类型, 描述
orgstring必选

The organization name. The name is not case sensitive.

HTTP 响应状态代码

状态代码描述
200

OK

代码示例

get/orgs/{org}/interaction-limits
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ 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.

参数

标头
名称, 类型, 描述
acceptstring

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

路径参数
名称, 类型, 描述
orgstring必选

The organization name. The name is not case sensitive.

正文参数
名称, 类型, 描述
limitstring必选

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

expirystring

The duration of the interaction restriction. Default: one_day.

可以是以下其中之一: one_day, three_days, one_week, one_month, six_months

HTTP 响应状态代码

状态代码描述
200

OK

422

Validation failed

代码示例

put/orgs/{org}/interaction-limits
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/orgs/ORG/interaction-limits

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.

参数

标头
名称, 类型, 描述
acceptstring

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

路径参数
名称, 类型, 描述
orgstring必选

The organization name. The name is not case sensitive.

HTTP 响应状态代码

状态代码描述
204

No Content

代码示例

delete/orgs/{org}/interaction-limits
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/orgs/ORG/interaction-limits

Response

Status: 204