Pontos de extremidade da API REST para interações do usuário
Use a API REST para restringir temporariamente o tipo de usuário que pode comentar, abrir problemas ou criar solicitações de pull nos seus repositórios públicos.
Sobre as interações de usuários
Você pode usar a API REST para restringir temporariamente o tipo de usuário que pode comentar, abrir problemas ou criar solicitações de pull nos seus repositórios públicos. Quando as restrições são habilitadas, apenas o tipo especificado de usuário de GitHub Enterprise Cloud 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 Enterprise Cloud:
- Usuários existentes: quando você limita as interações a
existing_users
, os novos usuários que têm contas com menos de 24 horas, que ainda não contribuíram e que não são colaboradores ficarão temporariamente restritos de interagir com seus repositórios. - Somente colaboradores: quando você limitar as interações aos
contributors_only
, os usuários que ainda não contribuíram e que não são colaboradores ficarão temporariamente restritos de interagir com seus repositórios. - Somente colaboradores: quando você limita as interações com
collaborators_only
, os usuários que não são colaboradores são temporariamente restringidos de interagir 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 em 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.
Tokens de acesso refinados para "Get interaction restrictions for your public repositories"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
O token refinado deve ter os seguintes conjuntos de permissões:
- "Interaction limits" user permissions (read)
Códigos de status de resposta HTTP para "Get interaction restrictions for your public repositories"
Código de status | Descrição |
---|---|
200 | Default response |
204 | Response when there are no restrictions |
Exemplos 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
.
Exemplo de solicitação
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 acesso refinados para "Set interaction restrictions for your public repositories"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
O token refinado deve ter os seguintes conjuntos de permissões:
- "Interaction limits" user permissions (write)
Parâmetros para "Set interaction restrictions for your public repositories"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
limit string ObrigatórioThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Pode ser um dos: |
expiry string The duration of the interaction restriction. Default: Pode ser um dos: |
Códigos de status de resposta HTTP para "Set interaction restrictions for your public repositories"
Código de status | Descrição |
---|---|
200 | OK |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos 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
.
Exemplo de solicitação
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 acesso refinados para "Remove interaction restrictions from your public repositories"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
O token refinado deve ter os seguintes conjuntos de permissões:
- "Interaction limits" user permissions (write)
Códigos de status de resposta HTTP para "Remove interaction restrictions from your public repositories"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos 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
.
Exemplo de solicitação
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