Puntos de conexión de la API de REST para interacciones de usuarios

Acerca de las interacciones del usuario

Puedes usar la API REST para restringir temporalmente qué tipo de usuario puede comentar, abrir incidencias o crear solicitudes de incorporación de cambios 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: al limitar las interacciones a existing_users, los nuevos usuarios con cuentas con menos de 24 horas de antigüedad que no hayan contribuido previamente y no sean colaboradores se restringirán temporalmente. de interactuar con tus repositorios.
Solo colaboradores: cuando limita las interacciones a contributors_only, se restringe temporalmente a los usuarios que no han contribuido previamente y no son colaboradores. de interactuar con tus repositorios.
Solo colaboradores: al limitar las interacciones a collaborators_only, los usuarios que no son colaboradores se restringirán temporalmente. 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. A fin de configurar otros límites de interacción para repositorios individuales que pertenezcan al usuario, en su lugar, use los puntos de conexión de interacciones de repositorio.

Get interaction restrictions for your public repositories

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

Tokens de acceso específicos para "Get interaction restrictions for your public repositories"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Interaction limits" user permissions (read)

Códigos de estado de respuesta HTTP para "Get interaction restrictions for your public repositories"

status code	Descripción
`200`	Default response
`204`	Response when there are no restrictions

Ejemplos de código para "Get interaction restrictions for your public repositories"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/user/interaction-limits

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/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.

Tokens de acceso específicos para "Set interaction restrictions for your public repositories"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Interaction limits" user permissions (write)

Parámetros para "Set interaction restrictions for your public repositories"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`limit` string Requerido The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Puede ser uno de los siguientes: `existing_users`, `contributors_only`, `collaborators_only`
`expiry` string The duration of the interaction restriction. Default: `one_day`. Puede ser uno de los siguientes: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`

Códigos de estado de respuesta HTTP para "Set interaction restrictions for your public repositories"

status code	Descripción
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Set interaction restrictions for your public repositories"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

put/user/interaction-limits

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/user/interaction-limits \
  -d '{"limit":"collaborators_only","expiry":"one_month"}'

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.

Tokens de acceso específicos para "Remove interaction restrictions from your public repositories"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Interaction limits" user permissions (write)

Códigos de estado de respuesta HTTP para "Remove interaction restrictions from your public repositories"

status code	Descripción
`204`	No Content

Ejemplos de código para "Remove interaction restrictions from your public repositories"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

delete/user/interaction-limits

curl -L \
  -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/user/interaction-limits

Response

Status: 204