Use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories.
About organization interactionsOrganization owners can temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories. When restrictions are enabled, only the specified type of GitHub user will be able to participate in interactions. Restrictions automatically expire after a defined duration. Here's more about the types of GitHub users:
existing_users, new users with accounts less than 24 hours old who have not previously contributed and are not collaborators will be temporarily restricted in the organization.contributors_only, users who have not previously contributed and are not collaborators will be temporarily restricted in the organization.collaborators_only, users who are not collaborators will be temporarily restricted in the organization.Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the Repository interactions endpoints instead.
Get interaction restrictions for an organization Code samples for "Get interaction restrictions for an organization"If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.
get/orgs/{org}/interaction-limits
Copy to clipboard curl request example
curl -L \ -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" }
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.
Fine-grained access tokens for "Set interaction restrictions for an organization"This endpoint works with the following fine-grained token types:
The fine-grained token must have the following permission set:
accept string
Setting to application/vnd.github+json is recommended.
org string Required
The organization name. The name is not case sensitive.
Body parameters Name, Type, Descriptionlimit string 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
The duration of the interaction restriction. Default: one_day.
Can be one of: one_day, three_days, one_week, one_month, six_months
200
OK
422
Validation failed, or the endpoint has been spammed.
Code samples for "Set interaction restrictions for an organization"If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.
put/orgs/{org}/interaction-limits
Copy to clipboard curl request example
curl -L \ -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" }
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4