Organization のインタラクション

Organization のインタラクション API を使うと、Organization の所有者は Organization のパブリックリポジトリでコメント、Issue のオープン、pull request の作成ができるユーザーの種類を一時的に制限できます。

Organization のインタラクション API について

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

OrganizationのExisting users(既存のユーザー): インタラクションを existing_users に制限すると、24 時間以下しか経過していないアカウントの新規ユーザーで、以前にコントリビューションしておらず、コラボレーターでもないユーザーは、一時的に制限されます。
OrganizationのContributors only (共同作成者のみ): 対話を contributors_only に制限すると、以前に投稿していない共同作成者ではないユーザーは一時的に制限されます
OrganizationのCollaborators only(コラボレーターのみ): インタラクションを collaborators_only に制限すると、コラボレーターではないユーザーは一時的に制限されます

Organizationレベルでインタラクション制限を設定すると、Organizationが所有する個々のリポジトリに設定されているインタラクション制限は上書きされます。 Organization が所有する個々のリポジトリに対して異なるインタラクション制限を設定するには、代わりにリポジトリインタラクションエンドポイントを使ってください。

Get interaction restrictions for an organization

Works with 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.

Parameters

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

Status code	Description
`200`	OK

Code samples

get/orgs/{org}/interaction-limits

curl \
  -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

Works with 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.

Parameters

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

Status code	Description
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Code samples

put/orgs/{org}/interaction-limits

curl \
  -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

Works with GitHub Apps

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

Parameters

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

Status code	Description
`204`	No Content

Code samples

delete/orgs/{org}/interaction-limits

curl \
  -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