Interactions de l’organisation
Utilisez l’API REST pour restreindre temporairement le type d’utilisateur qui peut commenter, ouvrir des problèmes ou créer des demandes de tirage sur les référentiels publics de l’organisation.
À propos des interactions d’organisation
Les propriétaires d’organisation peuvent restreindre temporairement le type d’utilisateur qui peut commenter, ouvrir des problèmes ou créer des demandes de tirage sur les référentiels publics de l’organisation. Lorsque des restrictions sont activées, seul le type spécifié d’utilisateur GitHub Enterprise Cloud pourra participer aux interactions. Les restrictions expirent automatiquement après une durée définie. Voici plus d’informations sur les types d’utilisateurs GitHub Enterprise Cloud :
- Utilisateurs existants : Lorsque vous limitez les interactions aux
existing_users
, les nouveaux utilisateurs avec des comptes de moins de 24 heures qui n’ont pas déjà contribué et qui ne sont pas collaborateurs seront temporairement limités. dans l’organisation. - Contributeurs uniquement : Lorsque vous limitez les interactions aux
contributors_only
, les utilisateurs qui n’ont pas déjà contribué et qui ne sont pas collaborateurs sont temporairement limités. dans l’organisation. - Collaborateurs uniquement : lorsque vous limitez les interactions en choisissant
collaborators_only
, les utilisateurs qui ne sont pas des collaborateurs sont temporairement limités dans l’organisation.
La définition de la limite d’interaction au niveau de l’organisation remplace toutes les limites d’interaction définies pour les référentiels individuels appartenant à l’organisation. Pour définir des limites d’interaction différentes pour les référentiels individuels appartenant à l’organisation, utilisez plutôt des points de terminaison d’interaction de référentiel.
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.
Parameters
Headers |
---|
Nom, Type, Description |
accept stringSetting to |
Path parameters |
Nom, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
HTTP response status codes
Status code | Description |
---|---|
200 | OK |
Code samples
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
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 |
---|
Nom, Type, Description |
accept stringSetting to |
Path parameters |
Nom, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
Body parameters |
Nom, Type, Description |
limit stringRequiredThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: |
expiry stringThe duration of the interaction restriction. Default: Can be one of: |
HTTP response status codes
Status code | Description |
---|---|
200 | OK |
422 | Validation failed, or the endpoint has been spammed. |
Code samples
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
Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
Parameters
Headers |
---|
Nom, Type, Description |
accept stringSetting to |
Path parameters |
Nom, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
HTTP response status codes
Status code | Description |
---|---|
204 | No Content |
Code samples
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