组织交互 - GitHub Docs

组织交互

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

关于组织交互 API

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

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

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

Get interaction restrictions for an organization

使用 GitHub Apps

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.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org`stringRequired 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: Bearer <YOUR-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

使用 GitHub Apps

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.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org`stringRequired The organization name. The name is not case sensitive.
Body parameters
Name, Type, Description
`limit`stringRequired The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`
`expiry`string The duration of the interaction restriction. Default: `one_day`. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`

HTTP 响应状态代码

状态代码	说明
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

代码示例

put/orgs/{org}/interaction-limits

curl \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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

使用 GitHub Apps

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

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org`stringRequired 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: Bearer <YOUR-TOKEN>" \
  https://api.github.com/orgs/ORG/interaction-limits

Response

Status: 204