インタラクション

リポジトリに対するインタラクションには、コミット、Issueのオープン、プルリクエストの作成があります。インタラクションAPIを使用すると、オーナーまたは管理者アクセス権のあるユーザはパブリックリポジトリの操作を一時的に特定のユーザのタイプに制限することができます。

Organization

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

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

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.

get /orgs/{org}/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/interaction-limits

JavaScript (@octokit/core.js)

await octokit.request('GET /orgs/{org}/interaction-limits', {
  org: 'org'
})

Response

 Status: 200 OK

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

注釈

Works with GitHub Apps

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.

put /orgs/{org}/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`limit`	string	body	Required. 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	body	The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.

コードサンプル

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/interaction-limits \
  -d '{"limit":"limit"}'

JavaScript (@octokit/core.js)

await octokit.request('PUT /orgs/{org}/interaction-limits', {
  org: 'org',
  limit: 'limit'
})

Response

 Status: 200 OK

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

Validation failed

 Status: 422 Unprocessable Entity

注釈

Works with GitHub Apps

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.

delete /orgs/{org}/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/interaction-limits

JavaScript (@octokit/core.js)

await octokit.request('DELETE /orgs/{org}/interaction-limits', {
  org: 'org'
})

Response

 Status: 204 No Content

注釈

Works with GitHub Apps

リポジトリ

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

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

リポジトリを所有しているユーザまたはOrganizationについてインタラクション制限を有効にしている場合、個々のリポジトリについてその制限を変更することはできません。インタラクション制限を変更するには、ユーザまたはOrganizationインタラクションエンドポイントを使用してください。

Get interaction restrictions for a repository

Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

get /repos/{owner}/{repo}/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits

JavaScript (@octokit/core.js)

await octokit.request('GET /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world'
})

Response

 Status: 200 OK

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

注釈

Works with GitHub Apps

Set interaction restrictions for a repository

Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

put /repos/{owner}/{repo}/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path
`limit`	string	body	Required. 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	body	The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.

コードサンプル

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits \
  -d '{"limit":"limit"}'

JavaScript (@octokit/core.js)

await octokit.request('PUT /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world',
  limit: 'limit'
})

Response

 Status: 200 OK

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

Response

 Status: 409 Conflict

注釈

Works with GitHub Apps

Remove interaction restrictions for a repository

Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

delete /repos/{owner}/{repo}/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits

JavaScript (@octokit/core.js)

await octokit.request('DELETE /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world'
})

Response

 Status: 204 No Content

Response

 Status: 409 Conflict

注釈

Works with GitHub Apps

Get interaction restrictions for your public repositories

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

get /user/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/user/interaction-limits

JavaScript (@octokit/core.js)

await octokit.request('GET /user/interaction-limits')

Default response

 Status: 200 OK

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

Response when there are no restrictions

 Status: 204 No Content

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.

put /user/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`limit`	string	body	Required. 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	body	The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.

コードサンプル

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/user/interaction-limits \
  -d '{"limit":"limit"}'

JavaScript (@octokit/core.js)

await octokit.request('PUT /user/interaction-limits', {
  limit: 'limit'
})

Response

 Status: 200 OK

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

Validation failed

 Status: 422 Unprocessable Entity

Remove interaction restrictions from your public repositories

Removes any interaction restrictions from your public repositories.

delete /user/interaction-limits

パラメータ

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/user/interaction-limits

JavaScript (@octokit/core.js)

await octokit.request('DELETE /user/interaction-limits')

Response

 Status: 204 No Content