User interactions
The User interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories.
About the User interactions API
La API de interacciones de usuario te permite restringir temporalmente qué tipo de usuario puede comentar, abrir propuestas o crear solicitudes de cambio en tus repositorios públicos. Cuando se habilitan las restricciones, solo el tipo de usuario de GitHub Enterprise Cloud que hayas especificado podrá participar en las interacciones. Las restricciones expiran automáticamente después de una duración definida. Aquí puedes aprender más sobre los tipos de usuario de GitHub Enterprise Cloud:
- Usuarios existentes: Cuando limitas las interacciones a
existing_users
, se restringirá temporalmente a los usuarios nuevos con cuentas de menos de 24 horas que no hayan hecho contribuciones anteriormente y que no sean colaboradores de interactuar con tus repositorios. - Solo para contribuyentes: Cuando limitas las interacciones para
contributors_only
, se restringirá temporalmente a los usuarios que no hayan hecho contribuciones anteriormente y que no sean colaboradores de interactuar con tus repositorios. - Solo para colaboradores: Cuando limitas las interacciones para
collaborators_only
, se restringirá temporalmente a los usuarios que no sean colaboradores de interactuar con tus repositorios.
El configurar el límite de interacción a nivel de usuario sobreescribirá cualquier límite de interacción que se configure para los repositorios individuales que le pertenezcan a éste. Para configurar límites de interacción diferentes para los repositorios individuales que pertenezcan al usuario, utiliza la terminal de interacciones de Repositorio en su lugar.
Get interaction restrictions for your public repositories
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | Default response |
204 | Response when there are no restrictions |
Ejemplos de código
curl \
-H "Accept: application/vnd.github+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.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
limit stringRequeridoThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Puede ser una de las siguientes: |
expiry stringThe duration of the interaction restriction. Default: Puede ser una de las siguientes: |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | OK |
422 | Validation failed |
Ejemplos de código
curl \
-X PUT \
-H "Accept: application/vnd.github+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.
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
204 | No Content |
Ejemplos de código
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <TOKEN>" \
https://api.github.com/user/interaction-limits
Response
Status: 204