REVIEWITDocumentação
Esta página é gerada a partir de Catalogue publié — GitHub — não se corrige à mão.Corrigir o contrato corrige a página. Modificá-la aqui perder-se-ia na próxima geração.GERADA EM 18 outubro 2026 · catalogue v23 · 9869e519
Referência geradaAtualizada · gerada em 18 outubro 2026

Contratos de coleta — GitHub

Tradução automática, ainda não revistaEsta página foi traduzida por um modelo a partir da versão francesa, que faz fé. Ler a versão francesa.

01Como ler esta página #sec_59ab4f32

Cada recurso que o REVIEWIT pode coletar para o GitHub tem um contrato publicado. Ele é lido como uma referência de API: o que o REVIEWIT chama no serviço coletado e por qual meio, o que o contrato exige para que a coleta seja executada e os dados que o REVIEWIT mantém. O REVIEWIT apenas realiza leituras.

  • Chamadas: as requisições que o REVIEWIT faz ao serviço coletado, todas em leitura.
  • Exigências: cada uma deve ser satisfeita. Sua natureza indica o que ela pede: um direito a conceder ao identificador, uma condição de administração (uma configuração ou atribuição no fornecedor que o token não possui, constatada por uma chamada real em leitura) ou a pertença do identificador à organização GitHub da conexão. A regra indica quantas opções são necessárias: « obrigatória » para a única opção, « uma à escolha » quando uma única basta (elas são ordenadas da mais estreita à mais ampla: prefira a primeira), « todas » ou « N à escolha entre M ».
  • Condições de funcionamento: o que o REVIEWIT constata antes de cada coleta, além das exigências.
  • Frescura: a idade máxima das verificações sobre as quais o veredicto se baseia, definida por cada contrato (aqui: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real). O REVIEWIT refaz automaticamente dentro desse prazo as verificações que ele sabe fazer (token obtido, serviço que responde); « Verificar os direitos », no menu da conexão, os refaz a pedido. Enquanto a chamada real não for feita, os direitos permanecem não constatados.
  • Dados mantidos: os campos que o REVIEWIT mantém de cada objeto; o papel indica o que a revisão faz com eles.

O veredicto de cada recurso, para sua conexão, é lido em sua ficha. Um recurso que a conexão não coleta pode sempre ser alimentado pela importação de um relatório (« Importar um relatório »).

02Como o REVIEWIT verifica as exigências #sec_41fe1f52

O token GitHub não possui seus direitos: o contrato exige que eles sejam constatados por uma chamada real, em leitura. O REVIEWIT ainda não faz essa chamada para o GitHub: ele constata que o token é obtido e que o serviço responde, mas não os direitos listados aqui. Os recursos são exibidos como « Não verificado »; eles podem sempre ser alimentados pela importação de um relatório (« Importar um relatório »).

03As vias de chamada #sec_0e4a82cf

Uma via indica qual token o REVIEWIT obtém para o identificador: quem o emite e para qual audiência. Os endereços chamados aparecem nas chamadas de cada recurso; um caminho que começa com « / » é chamado na audiência do token de sua via.

ViaToken emitido porAudiência do tokenAutenticação do identificador
github.rest.reviewit.app-installationhttps://api.github.com/app/installations/{installation}/access_tokenshttps://api.github.comchave privada do App GitHub (JWT assinado, trocado por um token de instalação)

Nesses endereços, {installation} é o identificador da instalação do App GitHub na organização.

04Ações & deployments · Ambientes #sec_660a0a3d

github.actions.environments:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Ambientes de implantação e seu escopo

Chamadas

  • GET /repos/{owner}/{repo}/environments

Exigências

NaturezaRegraOpções
Direitoobrigatória« Metadata : leitura »
Direitouma à escolha« Environments : leitura » ou « Actions : leitura »
Pertençaobrigatóriao identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.

Dados mantidos

CampoPapelTipoObrigatório
Idchave do objetointeirosim
RepoFullNameexibido para reconhecer o objetotextosim
EnvironmentNamecontexto, sem efeito sobre a revisãotextonão
CreatedAtcontexto, sem efeito sobre a revisãodata e horanão
UpdatedAtcontexto, sem efeito sobre a revisãodata e horanão
ProtectionRuleCountcontexto, sem efeito sobre a revisãointeironão

05Ações & implementações · Regras de proteção de ambiente #sec_d7d51cc9

github.actions.protection-rules:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Regras de proteção de ambientes: aprovadores requeridos, tempo de espera, proibição de auto-aprovação

Chamadas

  • GET /repos/{owner}/{repo}/environments/{env} (protection_rules, reviewers)
  • GET /repos/{owner}/{repo}/environments/{env}/deployment_protection_rules

Requisitos

NaturezaRegraOpções
Direitorequerido« Metadata : leitura »
Direitouma das opções« Environments : leitura » ou « Actions : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
Idchave do objetointeirosim
RepoFullNameexibido para reconhecer o objetotextosim
EnvironmentNamecontexto, sem efeito sobre a revisãotextonão
RuleTypecontexto, sem efeito sobre a revisãotextonão
ReviewerTypecontexto, sem efeito sobre a revisãotextonão
ReviewerLogincontexto, sem efeito sobre a revisãotextonão
WaitTimercontexto, sem efeito sobre a revisãointeironão
PreventSelfReviewcontexto, sem efeito sobre a revisãobooleanonão

06Ações & implementações · Grupos de executores auto-hospedados #sec_ccd12501

github.actions.runner-groups:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Grupos de executores auto-hospedados e os repositórios que acedem a eles

Chamadas

  • GET /orgs/{org}/actions/runner-groups
  • GET /orgs/{org}/actions/runner-groups/{id}/repositories

Requisitos

NaturezaRegraOpções
Direitorequerido« Organization self hosted runners : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
RunnerGroupIdchave do objetointeirosim
Nameexibido para reconhecer o objetotextosim
Visibilityavaliado pelas políticas REVIEWIT (visibilidade)textonão
AllowsPublicRepositoriescontexto, sem efeito sobre a revisãobooleanonão
SelectedRepositoriescontexto, sem efeito sobre a revisãotextonão
RunnerCountcontexto, sem efeito sobre a revisãointeironão

07Organizações · Membros e colaboradores externos #sec_e6a1a7c9

github.orgs.members:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Membros diretos, contas geridas (EMU) e colaboradores externos

Chamadas

  • GET /orgs/{org}/members?role=admin
  • GET /orgs/{org}/members?role=member
  • GET /orgs/{org}/members?filter=2fa_disabled
  • GET /orgs/{org}/outside_collaborators
  • GET /users/{username}

Requisitos

NaturezaRegraOpções
Direitorequerido« Members : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
Idchave do objetointeirosim
Loginexibido para reconhecer o objetotextosim
Nameexibido para reconhecer o objetotextonão
Emailexibido para reconhecer o objetotextonão
OrgLogincontexto, sem efeito sobre a revisãotextonão
Rolecontexto, sem efeito sobre a revisãotextonão
MembershipTypecontexto, sem efeito sobre a revisãotextonão
TwoFactorEnabledcontexto, sem efeito sobre a revisãobooleanonão
SuspendedOncontexto, sem efeito sobre a revisãodata e horanão

08Organizações · Organizações #sec_e1d6c322

github.orgs.organizations:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

A organização da conexão e suas configurações de acesso (permissão padrão de repositórios, criação de repositórios, autenticação dupla)

Chamadas

  • GET /orgs/{org} (parâmetros de segurança e básicos)

Requisitos

NaturezaRegraOpções
Direitorequerido« Organization administration : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
OrgIdchave do objetointeirosim
Loginexibido para reconhecer o objetotextosim
Nameexibido para reconhecer o objetotextonão
DefaultRepositoryPermissioncontexto, sem efeito sobre a revisãotextonão
MembersCanCreateReposcontexto, sem efeito sobre a revisãobooleanonão
TwoFactorRequiredcontexto, sem efeito sobre a revisãobooleanonão
CreatedOncontexto, sem efeito sobre a revisãodata e horanão

09Papéis privilegiados · Proprietários e administradores #sec_7c3212bc

github.privileged-roles.owners:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Proprietários da organização (membros com papel de admin)

Chamadas

  • GET /orgs/{org}/members?role=admin

Requisitos

NaturezaRegraOpções
Direitoobrigatório« Members : leitura »
Afiliaçãoobrigatórioo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações com menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoPapelTipoObrigatório
Idchave do objetointeirosim
Loginexibido para reconhecer o objetotextosim
Nameexibido para reconhecer o objetotextonão
Emailexibido para reconhecer o objetotextonão
Scopecontexto, sem efeito sobre a revisãotextonão
RoleNameexibido para reconhecer o objetotextonão
OrgLogincontexto, sem efeito sobre a revisãotextonão
TwoFactorEnabledcontexto, sem efeito sobre a revisãobooleanonão

10Papéis privilegiados · Gerentes de segurança #sec_b29bd864

github.privileged-roles.security-managers:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Equipes com o papel de gestão de segurança

Chamadas

  • GET /orgs/{org}/organization-roles
  • GET /orgs/{org}/organization-roles/{id}/teams

Requisitos

NaturezaRegraOpções
Direitoobrigatório« Organization administration : leitura »
Afiliaçãoobrigatórioo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações com menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoPapelTipoObrigatório
Idchave do objetointeirosim
TeamSlugexibido para reconhecer o objetotextosim
TeamNamecontexto, sem efeito sobre a revisãotextonão
OrgLogincontexto, sem efeito sobre a revisãotextonão
MemberCountcontexto, sem efeito sobre a revisãointeironão
GrantedOncontexto, sem efeito sobre a revisãodata e horanão

11Projetos · Projetos (v2) #sec_e9607f7e

github.projects.projects:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Projetos de planejamento e as contas que acedem a eles

Chamadas

  • POST /graphql (organization.projectsV2)

Requisitos

NaturezaRegraOpções
Direitoobrigatório« Organization projects : leitura »
Afiliaçãoobrigatórioo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações com menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoPapelTipoObrigatório
ProjectIdchave do objetotextosim
Numbercontexto, sem efeito sobre a revisãointeironão
Titleexibido para reconhecer o objetotextosim
Owneracesso sujeito à revisãolista de identidadesnão
Publicavaliado pelas políticas REVIEWIT (visibilidade)booleanonão
Closedcontexto, sem efeito sobre a revisãobooleanonão

12Repositórios · Colaboradores do repositório #sec_638fd686

github.repos.collaborators:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Acesso direto de uma conta a um repositório, com sua permissão. Chave de linha : RepoFullName | Id.

Chamadas

  • GET /repos/{owner}/{repo}/collaborators?affiliation=direct

Requisitos

NaturezaRegraOpções
Direitoobrigatório« Metadata : leitura »
Direitoobrigatório« Administration : leitura »
Afiliaçãoobrigatórioo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações com menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoPapelTipoObrigatório
AccessKeychave do objetotextosim
Idcontexto, sem efeito sobre a revisãointeirosim
RepoFullNamecontexto, sem efeito sobre a revisãotextosim
Loginexibido para reconhecer o objetotextosim
Nameexibido para reconhecer o objetotextonão
Permissioncontexto, sem efeito sobre a revisãotextonão
RoleNameexibido para reconhecer o objetotextonão
IsOutsideCollaboratorcontexto, sem efeito sobre a revisãobooleanonão

13Repositórios #sec_6eb1229a

github.repos.repositories:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Repositórios, sua visibilidade, arquivamento e proprietário

Chamadas

  • GET /orgs/{org}/repos

Requisitos

NaturezaRegraOpções
Direitorequerido« Metadata : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações de menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
RepoIdchave do objetointeirosim
FullNameexibido para reconhecer o objetotextosim
Visibilityavaliado pelas políticas REVIEWIT (visibilidade)textonão
Archivedcontexto, sem efeito sobre a revisãobooleanonão
Forkcontexto, sem efeito sobre a revisãobooleanonão
DefaultBranchcontexto, sem efeito sobre a revisãotextonão
Owneracesso sujeito à revisãolista de identidadesnão
PushedAtavaliado pelas políticas REVIEWIT (data da última atividade)data e horanão
CreatedAtcontexto, sem efeito sobre a revisãodata e horanão

14Repositórios · Conjuntos de regras e proteção de ramificação #sec_0621c1bf

github.repos.rulesets:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Regras de proteção e atores autorizados a contorná-las

Chamadas

  • GET /repos/{owner}/{repo}/rulesets
  • GET /repos/{owner}/{repo}/branches/{branch}/protection
  • GET /orgs/{org}/rulesets

Requisitos

NaturezaRegraOpções
Direitorequerido« Administração : leitura »
Direitorequerido« Administração da organização : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações de menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
RulesetIdchave do objetointeirosim
Nameexibido para reconhecer o objetotextosim
Targetcontexto, sem efeito sobre a revisãotextonão
Enforcementcontexto, sem efeito sobre a revisãotextonão
RepoFullNamecontexto, sem efeito sobre a revisãotextonão
BypassActorTypecontexto, sem efeito sobre a revisãotextonão
BypassActorIdcontexto, sem efeito sobre a revisãotextonão
BypassModecontexto, sem efeito sobre a revisãotextonão

15Repositórios · Acesso da equipe ao repositório #sec_f5e716e3

github.repos.team-access:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Acesso de uma equipe a um repositório, com sua permissão. Chave de linha : RepoFullName | Id.

Chamadas

  • GET /repos/{owner}/{repo}/teams

Requisitos

NaturezaRegraOpções
Direitorequerido« Metadata : leitura »
Direitorequerido« Administração : leitura »
Direitorequerido« Membros : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações de menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
AccessKeychave do objetotextosim
Idcontexto, sem efeito sobre a revisãointeirosim
RepoFullNamecontexto, sem efeito sobre a revisãotextosim
TeamSlugcontexto, sem efeito sobre a revisãotextonão
TeamNamecontexto, sem efeito sobre a revisãotextonão
Permissioncontexto, sem efeito sobre a revisãotextonão
RoleNameexibido para reconhecer o objetotextosim

16Equipes · Membros da equipe #sec_3726d567

github.teams.memberships:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Afiliações de equipe e papel (membro ou mantenedor). Chave de linha : TeamSlug | Id.

Chamadas

  • GET /orgs/{org}/teams/{team}/members?role=maintainer
  • GET /orgs/{org}/teams/{team}/members?role=member

Requisitos

NaturezaRegraOpções
Direitorequerido« Membros : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações de menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados conservados

CampoFunçãoTipoObrigatório
MembershipKeychave do objetotextosim
Idcontexto, sem efeito sobre a revisãointeirosim
TeamSlugcontexto, sem efeito sobre a revisãotextosim
TeamNamecontexto, sem efeito sobre a revisãotextonão
Loginexibido para reconhecer o objetotextosim
Nameexibido para reconhecer o objetotextonão
Emailexibido para reconhecer o objetotextonão
Rolecontexto, sem efeito sobre a revisãotextonão
IsDirectcontexto, sem efeito sobre a revisãobooleanonão

17Equipas #sec_747f8015

github.teams.teams:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Equipas, sua hierarquia e visibilidade

Chamadas

  • GET /orgs/{org}/teams

Requisitos

NaturezaRegraOpções
Direitorequerido« Membros : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações com menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados mantidos

CampoPapelTipoObrigatório
TeamIdchave do objetointeirosim
Nameexibido para reconhecer o objetotextosim
Slugexibido para reconhecer o objetotextonão
Descriptioncontexto, sem efeito sobre a revisãotextonão
Privacyavaliado pelas políticas REVIEWIT (visibilidade)textonão
ParentTeamcontexto, sem efeito sobre a revisãotextonão
Permissioncontexto, sem efeito sobre a revisãotextonão
MemberCountcontexto, sem efeito sobre a revisãointeironão

18Aplicações de terceiros · Instalações de GitHub App #sec_a4f42618

github.apps.installations:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Aplicações instaladas, suas permissões e escopo de repositórios

Chamadas

  • GET /orgs/{org}/installations

Requisitos

NaturezaRegraOpções
Direitorequerido« Administração da organização : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações com menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados mantidos

CampoPapelTipoObrigatório
InstallationIdchave do objetointeirosim
AppSlugexibido para reconhecer o objetotextosim
AppNamecontexto, sem efeito sobre a revisãotextonão
TargetTypecontexto, sem efeito sobre a revisãotextonão
TargetLogincontexto, sem efeito sobre a revisãotextonão
RepositorySelectioncontexto, sem efeito sobre a revisãotextonão
Permissionscontexto, sem efeito sobre a revisãotextonão
CreatedAtcontexto, sem efeito sobre a revisãodata e horanão

19Aplicações de terceiros · Tokens de acesso pessoal #sec_b4797b61

github.apps.personal-access-tokens:collect · revisão 1 do contrato, publicada em 18 de outubro de 2026 · via github.rest.reviewit.app-installation

Tokens de acesso pessoal de granularidade fina com acesso à organização : portador, validade, escopo, última utilização

Chamadas

  • GET /orgs/{org}/personal-access-tokens

Requisitos

NaturezaRegraOpções
Direitorequerido« Tokens de acesso pessoal da organização : leitura »
Afiliaçãorequeridoo identificador pertence à organização GitHub da conexão

Condições de funcionamento

  • um token é obtido para o identificador
  • o serviço https://api.github.com responde

Frescura : verificações com menos de 24 h ; os direitos devem ser constatados por uma chamada real.

Dados mantidos

CampoPapelTipoObrigatório
TokenIdchave do objetointeirosim
Nameexibido para reconhecer o objetotextosim
OwnerLogincontexto, sem efeito sobre a revisãotextonão
TokenTypecontexto, sem efeito sobre a revisãotextonão
Scopescontexto, sem efeito sobre a revisãotextonão
RepositorySelectioncontexto, sem efeito sobre a revisãotextonão
CreatedAtcontexto, sem efeito sobre a revisãodata e horanão
ExpiresAtcontexto, sem efeito sobre a revisãodata e horanão
LastUsedavaliado pelas políticas REVIEWIT (data da última atividade)data e horanão

20Para ir além #sec_889c6ab2

  • Compreender uma conexão de coleta
  • Referência dos direitos por recurso
  • Ler um veredicto
Esc
↑↓ navegar↵ abrirVer todos os resultados →