Interações do usuário

A API de Interações do Usuário permite restringir temporariamente que tipo de usuário pode comentar, abrir problemas ou criar pull requests nos seus repositórios públicos.

Sobre a API de interações do usuário

A API de Interações do Usuário permite restringir temporariamente que tipo de usuário pode comentar, abrir problemas ou criar pull requests nos seus repositórios públicos. Quando as restrições são habilitadas, apenas o tipo especificado de usuário de GitHub poderá participar das interações. As restrições expiram automaticamente após uma duração definida. Veja mais sobre os tipos de usuários de GitHub:

Usuários existentes: Quando você limitar as interações para existing_users, novos usuários com contas com menos de 24 horas de idade, que não tenham contribuído anteriormente e que não sejam colaboradores, estarão temporariamente restritos de interagir com seus repositórios.
Colaboradores apenas: quando você limitar as interações para contributors_only, usuários que não contribuíram anteriormente e não são colaboradores serão temporariamente restritos de interagir com seus repositórios.
Colaboradores apenas: quando você limitar as interações para collaborators_only, os usuários que não forem colaboradores ficarão temporariamente restritos de interagir com seus repositórios.

Definir o limite de interação no nível do usuário sobrescreverá quaisquer limites de interação definidos para repositórios individuais pertencentes ao usuário. Para definir diferentes limites de interação para repositórios individuais pertencentes ao usuário, use os pontos de extremidade das interações do Repositório.

Get interaction restrictions for your public repositories

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

HTTP response status codes

Status code	Descrição
`200`	Default response
`204`	Response when there are no restrictions

Amostras de código

get/user/interaction-limits

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

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Body parameters
Nome, Tipo, Descrição
`limit`stringObrigatório The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Pode ser uma das ações a seguir: `existing_users`, `contributors_only`, `collaborators_only`
`expiry`string The duration of the interaction restriction. Default: `one_day`. Pode ser uma das ações a seguir: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`

HTTP response status codes

Status code	Descrição
`200`	OK
`422`	Validation failed

Amostras de código

put/user/interaction-limits

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.

HTTP response status codes

Status code	Descrição
`204`	No Content

Amostras de código

delete/user/interaction-limits

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/user/interaction-limits

Response

Status: 204