O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

Pontos de extremidade da API REST para interações com a organização

Use a API REST para restringir temporariamente o tipo de usuário que pode comentar, abrir problemas ou criar solicitações de pull no repositório público de uma organização.

Sobre as interações de organização

Os proprietários da organização podem restringir temporariamente o tipo de usuário que pode comentar, abrir problemas ou criar solicitações de pull no repositório público da organização. Quando as restrições são habilitadas, apenas o tipo especificado de usuário do GitHub poderá participar das interações. As restrições expiram automaticamente após uma duração definida. Saiba mais sobre os tipos de usuários do GitHub:

  • 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 na organização.
  • 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 na organização.
  • 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 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 em repositórios individuais pertencentes à organização, use os pontos de extremidade das interações do Repositório.

Get interaction restrictions for an organization

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.

Tokens de acesso refinados para "Get interaction restrictions for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

  • "Administration" organization permissions (read)

Parâmetros para "Get interaction restrictions for an organization"

Cabeçalhos
accept string

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

Parâmetros de caminho
org string Obrigatório

The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP para "Get interaction restrictions for an organization"

Código de statusDescrição
200

OK

Exemplos de código para "Get interaction restrictions for an organization"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/orgs/{org}/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/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

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.

Tokens de acesso refinados para "Set interaction restrictions for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

  • "Administration" organization permissions (write)

Parâmetros para "Set interaction restrictions for an organization"

Cabeçalhos
accept string

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

Parâmetros de caminho
org string Obrigatório

The organization name. The name is not case sensitive.

Parâmetros do corpo
limit string Obrigatório

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

Pode ser um dos: existing_users, contributors_only, collaborators_only

expiry string

The duration of the interaction restriction. Default: one_day.

Pode ser um dos: one_day, three_days, one_week, one_month, six_months

Códigos de status de resposta HTTP para "Set interaction restrictions for an organization"

Código de statusDescrição
200

OK

422

Validation failed, or the endpoint has been spammed.

Exemplos de código para "Set interaction restrictions for an organization"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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

Response

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

Remove interaction restrictions for an organization

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

Tokens de acesso refinados para "Remove interaction restrictions for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

  • "Administration" organization permissions (write)

Parâmetros para "Remove interaction restrictions for an organization"

Cabeçalhos
accept string

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

Parâmetros de caminho
org string Obrigatório

The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP para "Remove interaction restrictions for an organization"

Código de statusDescrição
204

No Content

Exemplos de código para "Remove interaction restrictions for an organization"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

delete/orgs/{org}/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/orgs/ORG/interaction-limits

Response

Status: 204