REVIEWITDocumentation
This page is generated from Catalogue publié — GitHub — it cannot be corrected by hand.Correcting the contract corrects the page. Editing it here would be lost at the next generation.GENERATED ON 18 October 2026 · catalogue v23 · 9869e519
Generated referenceUp to date · generated on 18 October 2026

Collection Contracts — GitHub

Machine translation, not yet reviewedThis page was translated by a model from the French version, which is authoritative. Read the French version.

01How to read this page #sec_59ab4f32

Each resource that REVIEWIT can collect for GitHub has a published contract. It is read like an API reference: what REVIEWIT calls on the collected service and by what means, what the contract requires for the collection to execute, and the data that REVIEWIT retains. REVIEWIT only performs reads.

  • Calls: the requests that REVIEWIT sends to the collected service, all in read mode.
  • Requirements: each must be satisfied. Its nature indicates what it demands: a right to grant to the identifier, an administration condition (a setting or assignment at the provider that the token does not carry, verified by a real read call), or the identifier's membership in the GitHub organization of the connection. The rule states how many options are needed: “required” for the single option, “one of” when one is sufficient (they are ranked from narrowest to broadest: prefer the first), “all”, or “N of M to choose from.”
  • Operational conditions: what REVIEWIT verifies before each collection, beyond the requirements.
  • Freshness: the maximum age of the verifications on which the verdict is based, set by each contract (here: verifications less than 24 hours old; rights must be verified by a real call). REVIEWIT automatically redoes verifications it can perform within this period (token obtained, service responding); “Verify rights,” in the connection menu, redoes them on demand. As long as the real call has not been made, the rights remain unverified.
  • Data retained: the fields that REVIEWIT keeps from each object; the role indicates what the review does with it.

The verdict of each resource, for your connection, is read on its card. A resource that the connection does not collect can still be fed by importing a report (“Import a report”).

02How REVIEWIT verifies requirements #sec_41fe1f52

The GitHub token does not carry its rights: the contract requires that they be verified by a real call, in read mode. REVIEWIT does not yet make this call for GitHub: it verifies that the token is obtained and that the service responds, but not the rights listed here. Resources appear as “Not verified”; they can still be fed by importing a report (“Import a report”).

03Call paths #sec_0e4a82cf

A path indicates which token REVIEWIT obtains for the identifier: who issues it and for which audience. The called addresses are listed in the calls of each resource; a path starting with “/” is called on the token's audience of its path.

PathToken issued byToken audienceIdentifier authentication
github.rest.reviewit.app-installationhttps://api.github.com/app/installations/{installation}/access_tokenshttps://api.github.comGitHub App private key (JWT signed, exchanged for an installation token)

In these addresses, {installation} is the identifier of the GitHub App installation in the organization.

04Actions & deployments · Environments #sec_660a0a3d

github.actions.environments:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Deployment environments and their scope

Calls

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

Requirements

NatureRuleOptions
Rightrequired“Metadata: read”
Rightone of“Environments: read” or “Actions: read”
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operational conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: verifications less than 24 hours old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
Idobject keyintegeryes
RepoFullNamedisplayed to recognize the objecttextyes
EnvironmentNamecontext, no effect on the reviewtextno
CreatedAtcontext, no effect on the reviewdate and timeno
UpdatedAtcontext, no effect on the reviewdate and timeno
ProtectionRuleCountcontext, no effect on the reviewintegerno

05Actions & deployments · Environment protection rules #sec_d7d51cc9

github.actions.protection-rules:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Environment protection rules: required approvers, waiting period, self-approval prohibition

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Metadata: read »
Rightone of« Environments: read » or « Actions: read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
Idobject keyintegeryes
RepoFullNamedisplayed to recognize the objecttextyes
EnvironmentNamecontext, no effect on reviewtextno
RuleTypecontext, no effect on reviewtextno
ReviewerTypecontext, no effect on reviewtextno
ReviewerLogincontext, no effect on reviewtextno
WaitTimercontext, no effect on reviewintegerno
PreventSelfReviewcontext, no effect on reviewbooleanno

06Actions & deployments · Self-hosted runner groups #sec_ccd12501

github.actions.runner-groups:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Self-hosted runner groups and the repositories that access them

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Organization self hosted runners: read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
RunnerGroupIdobject keyintegeryes
Namedisplayed to recognize the objecttextyes
Visibilityevaluated by REVIEWIT policies (visibility)textno
AllowsPublicRepositoriescontext, no effect on reviewbooleanno
SelectedRepositoriescontext, no effect on reviewtextno
RunnerCountcontext, no effect on reviewintegerno

07Organisations · Members and outside collaborators #sec_e6a1a7c9

github.orgs.members:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Direct members, managed accounts (EMU) and outside collaborators

Calls

  • 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}

Requirements

NatureRuleOptions
Rightrequired« Members: read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
Idobject keyintegeryes
Logindisplayed to recognize the objecttextyes
Namedisplayed to recognize the objecttextno
Emaildisplayed to recognize the objecttextno
OrgLogincontext, no effect on reviewtextno
Rolecontext, no effect on reviewtextno
MembershipTypecontext, no effect on reviewtextno
TwoFactorEnabledcontext, no effect on reviewbooleanno
SuspendedOncontext, no effect on reviewdate and timeno

08Organisations · Organizations #sec_e1d6c322

github.orgs.organizations:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

The connection's organization and its access settings (default repository permission, repository creation, two-factor authentication)

Calls

  • GET /orgs/{org} (security and basic parameters)

Requirements

NatureRuleOptions
Rightrequired« Organization administration: read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
OrgIdobject keyintegeryes
Logindisplayed to recognize the objecttextyes
Namedisplayed to recognize the objecttextno
DefaultRepositoryPermissioncontext, no effect on reviewtextno
MembersCanCreateReposcontext, no effect on reviewbooleanno
TwoFactorRequiredcontext, no effect on reviewbooleanno
CreatedOncontext, no effect on reviewdate and timeno

09Privileged roles · Owners and admins #sec_7c3212bc

github.privileged-roles.owners:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Organization owners (members with admin role)

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Members : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the https://api.github.com service responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
Idobject keyintegeryes
Logindisplayed to recognize the objecttextyes
Namedisplayed to recognize the objecttextno
Emaildisplayed to recognize the objecttextno
Scopecontext, no effect on the reviewtextno
RoleNamedisplayed to recognize the objecttextno
OrgLogincontext, no effect on the reviewtextno
TwoFactorEnabledcontext, no effect on the reviewbooleanno

10Privileged roles · Security managers #sec_b29bd864

github.privileged-roles.security-managers:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Teams with the security management role

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Organization administration : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the https://api.github.com service responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
Idobject keyintegeryes
TeamSlugdisplayed to recognize the objecttextyes
TeamNamecontext, no effect on the reviewtextno
OrgLogincontext, no effect on the reviewtextno
MemberCountcontext, no effect on the reviewintegerno
GrantedOncontext, no effect on the reviewdate and timeno

11Projects · Projects (v2) #sec_e9607f7e

github.projects.projects:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Planning projects and the accounts that access them

Calls

  • POST /graphql (organization.projectsV2)

Requirements

NatureRuleOptions
Rightrequired« Organization projects : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the https://api.github.com service responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
ProjectIdobject keytextyes
Numbercontext, no effect on the reviewintegerno
Titledisplayed to recognize the objecttextyes
Owneraccess subject to reviewlist of identitiesno
Publicevaluated by REVIEWIT policies (visibility)booleanno
Closedcontext, no effect on the reviewbooleanno

12Repositories · Repository collaborators #sec_638fd686

github.repos.collaborators:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Direct access of an account to a repository, with its permission. Line key: RepoFullName | Id.

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Metadata : read »
Rightrequired« Administration : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the https://api.github.com service responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
AccessKeyobject keytextyes
Idcontext, no effect on the reviewintegeryes
RepoFullNamecontext, no effect on the reviewtextyes
Logindisplayed to recognize the objecttextyes
Namedisplayed to recognize the objecttextno
Permissioncontext, no effect on the reviewtextno
RoleNamedisplayed to recognize the objecttextno
IsOutsideCollaboratorcontext, no effect on the reviewbooleanno

13Repositories #sec_6eb1229a

github.repos.repositories:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Repositories, their visibility, their archiving, and their owner

Calls

  • GET /orgs/{org}/repos

Requirements

NatureRuleOptions
Rightrequired« Metadata : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
RepoIdobject keyintegeryes
FullNamedisplayed to recognize the objecttextyes
Visibilityevaluated by REVIEWIT policies (visibility)textno
Archivedcontext, no effect on reviewbooleanno
Forkcontext, no effect on reviewbooleanno
DefaultBranchcontext, no effect on reviewtextno
Owneraccess subject to reviewlist of identitiesno
PushedAtevaluated by REVIEWIT policies (last activity date)date and timeno
CreatedAtcontext, no effect on reviewdate and timeno

14Repositories · Rulesets and branch protection #sec_0621c1bf

github.repos.rulesets:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Protection rules and actors authorized to bypass them

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Administration : read »
Rightrequired« Organization administration : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
RulesetIdobject keyintegeryes
Namedisplayed to recognize the objecttextyes
Targetcontext, no effect on reviewtextno
Enforcementcontext, no effect on reviewtextno
RepoFullNamecontext, no effect on reviewtextno
BypassActorTypecontext, no effect on reviewtextno
BypassActorIdcontext, no effect on reviewtextno
BypassModecontext, no effect on reviewtextno

15Repositories · Repository team access #sec_f5e716e3

github.repos.team-access:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Team access to a repository, with its permission. Line key: RepoFullName | Id.

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Metadata : read »
Rightrequired« Administration : read »
Rightrequired« Members : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
AccessKeyobject keytextyes
Idcontext, no effect on reviewintegeryes
RepoFullNamecontext, no effect on reviewtextyes
TeamSlugcontext, no effect on reviewtextno
TeamNamecontext, no effect on reviewtextno
Permissioncontext, no effect on reviewtextno
RoleNamedisplayed to recognize the objecttextyes

16Teams · Team members #sec_3726d567

github.teams.memberships:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Team memberships and role (member or maintainer). Line key: TeamSlug | Id.

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Members : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
MembershipKeyobject keytextyes
Idcontext, no effect on reviewintegeryes
TeamSlugcontext, no effect on reviewtextyes
TeamNamecontext, no effect on reviewtextno
Logindisplayed to recognize the objecttextyes
Namedisplayed to recognize the objecttextno
Emaildisplayed to recognize the objecttextno
Rolecontext, no effect on reviewtextno
IsDirectcontext, no effect on reviewbooleanno

17Teams #sec_747f8015

github.teams.teams:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Teams, their hierarchy and visibility

Calls

  • GET /orgs/{org}/teams

Requirements

NatureRuleOptions
Rightrequired« Members : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
TeamIdobject keyintegeryes
Namedisplayed to recognize the objecttextyes
Slugdisplayed to recognize the objecttextno
Descriptioncontext, no effect on reviewtextno
Privacyevaluated by REVIEWIT policies (visibility)textno
ParentTeamcontext, no effect on reviewtextno
Permissioncontext, no effect on reviewtextno
MemberCountcontext, no effect on reviewintegerno

18Third-party apps · GitHub App installations #sec_a4f42618

github.apps.installations:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Installed applications, their permissions and repository scope

Calls

  • GET /orgs/{org}/installations

Requirements

NatureRuleOptions
Rightrequired« Organization administration : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
InstallationIdobject keyintegeryes
AppSlugdisplayed to recognize the objecttextyes
AppNamecontext, no effect on reviewtextno
TargetTypecontext, no effect on reviewtextno
TargetLogincontext, no effect on reviewtextno
RepositorySelectioncontext, no effect on reviewtextno
Permissionscontext, no effect on reviewtextno
CreatedAtcontext, no effect on reviewdate and timeno

19Third-party apps · Personal access tokens #sec_b4797b61

github.apps.personal-access-tokens:collect · contract revision 1, published on October 18, 2026 · path github.rest.reviewit.app-installation

Fine-grained personal access tokens with access to the organization: bearer, expiration, scope, last use

Calls

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

Requirements

NatureRuleOptions
Rightrequired« Organization personal access tokens : read »
Membershiprequiredthe identifier belongs to the GitHub organization of the connection

Operating conditions

  • a token is obtained for the identifier
  • the service https://api.github.com responds

Freshness: checks less than 24 h old; rights must be verified by a real call.

Data retained

FieldRoleTypeRequired
TokenIdobject keyintegeryes
Namedisplayed to recognize the objecttextyes
OwnerLogincontext, no effect on reviewtextno
TokenTypecontext, no effect on reviewtextno
Scopescontext, no effect on reviewtextno
RepositorySelectioncontext, no effect on reviewtextno
CreatedAtcontext, no effect on reviewdate and timeno
ExpiresAtcontext, no effect on reviewdate and timeno
LastUsedevaluated by REVIEWIT policies (last activity date)date and timeno

20To go further #sec_889c6ab2

  • Understand a collection connection
  • Rights reference by resource
  • Read a verdict
Esc
↑↓ navigate↵ openSee all results →