Skip to main content

Interações da organização

A API de interações da organização permite que os proprietários da organização restrinjam temporariamente qual tipo de usuário pode comentar, abrir problemas ou criar pull requests nos repositórios públicos da organização.

Sobre a API de interações da organização

A API de interações da organização permite que os proprietários da organização restrinjam temporariamente qual tipo de usuário pode comentar, abrir problemas ou criar pull requests nos repositórios públicos da organização. 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 na organização.
  • 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 na organização.
  • Colaboradores apenas: quando você limitar as interações para collaborators_only, os usuários que não forem colaboradores ficarão temporariamente restritos na organização.

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

Get interaction restrictions for an organization

Works with GitHub Apps

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.

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
Nome, Tipo, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

get/orgs/{org}/interaction-limits
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ 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

Works with GitHub Apps

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.

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
Nome, Tipo, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

Body parameters
Nome, Tipo, Descrição
limitstringObrigató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

expirystring

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 codeDescrição
200

OK

422

Validation failed

Amostras de código

put/orgs/{org}/interaction-limits
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/orgs/ORG/interaction-limits

Response

Status: 200
{ "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" }

Remove interaction restrictions for an organization

Works with GitHub Apps

Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
Nome, Tipo, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

delete/orgs/{org}/interaction-limits
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/orgs/ORG/interaction-limits

Response

Status: 204