Skip to main content

ユーザインタラクション

User interactions APIを使用すると、自分のパブリックリポジトリでコメント、Issueのオープン、プルリクエストの作成ができるユーザのタイプを一時的に制限することができます。

User interactions APIについて

User interactions APIを使用すると、自分のパブリックリポジトリでコメント、Issueのオープン、プルリクエストの作成ができるユーザのタイプを一時的に制限することができます。 制限が有効化されると、指定した種類のGitHubユーザのみがインタラクションに参加できるようになります。 制限は、定義された期間の後に自動的に期限切れになります。 GitHub ユーザのタイプについては以下を参照してください。

  • Existing users(既存のユーザ): インタラクションをexisting_usersに制限すると、24時間以下しか経過していないアカウントの新規ユーザで、以前にコントリビューションしておらず、コラボレーターでもないユーザは、一時的に制限されます。によるリポジトリの操作を制限します。
  • Contributors only(コントリビューターのみ):インタラクションをcontributors_onlyに制限すると、以前にコントリビューションしておらず、コラボレーターでもないユーザは一時的に制限されます。によるリポジトリの操作を制限します。
  • Collaborators 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 response status codes

Status code説明
200

Default response

204

Response when there are no restrictions

コードサンプル

get/user/interaction-limits
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <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
名前, 種類, 説明
acceptstring

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

Body parameters
名前, 種類, 説明
limitstring必須

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 response status codes

Status code説明
200

OK

422

Validation failed

コードサンプル

put/user/interaction-limits
curl \ -X PUT \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/interaction-limits

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 response status codes

Status code説明
204

No Content

コードサンプル

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

Response

Status: 204