Skip to main content

用户交互

用户交互 API 允许你临时限制哪类用户可以在公共存储库上发表评论、开启问题或创建拉取请求。

关于用户交互 API

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

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

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

Get interaction restrictions for your public repositories

Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

HTTP 响应状态代码

状态代码说明
200

Default response

204

Response when there are no restrictions

代码示例

get/user/interaction-limits
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://api.github.com/user/interaction-limits

Default response

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

Set interaction restrictions for your public repositories

Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

参数

Headers
Name, Type, Description
acceptstring

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

Body parameters
Name, Type, Description
limitstringRequired

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

expirystring

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/user/interaction-limits
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://api.github.com/user/interaction-limits \ -d '{"limit":"collaborators_only","expiry":"one_month"}'

Response

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

Remove interaction restrictions from your public repositories

Removes any interaction restrictions from your public repositories.

HTTP 响应状态代码

状态代码说明
204

No Content

代码示例

delete/user/interaction-limits
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://api.github.com/user/interaction-limits

Response

Status: 204