Collection Contracts — GitHub
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.
| Path | Token issued by | Token audience | Identifier authentication |
|---|---|---|---|
| github.rest.reviewit.app-installation | https://api.github.com/app/installations/{installation}/access_tokens | https://api.github.com | GitHub 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
| Nature | Rule | Options |
|---|---|---|
| Right | required | “Metadata: read” |
| Right | one of | “Environments: read” or “Actions: read” |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| Id | object key | integer | yes |
| RepoFullName | displayed to recognize the object | text | yes |
| EnvironmentName | context, no effect on the review | text | no |
| CreatedAt | context, no effect on the review | date and time | no |
| UpdatedAt | context, no effect on the review | date and time | no |
| ProtectionRuleCount | context, no effect on the review | integer | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Metadata: read » |
| Right | one of | « Environments: read » or « Actions: read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| Id | object key | integer | yes |
| RepoFullName | displayed to recognize the object | text | yes |
| EnvironmentName | context, no effect on review | text | no |
| RuleType | context, no effect on review | text | no |
| ReviewerType | context, no effect on review | text | no |
| ReviewerLogin | context, no effect on review | text | no |
| WaitTimer | context, no effect on review | integer | no |
| PreventSelfReview | context, no effect on review | boolean | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Organization self hosted runners: read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| RunnerGroupId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| Visibility | evaluated by REVIEWIT policies (visibility) | text | no |
| AllowsPublicRepositories | context, no effect on review | boolean | no |
| SelectedRepositories | context, no effect on review | text | no |
| RunnerCount | context, no effect on review | integer | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Members: read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| Id | object key | integer | yes |
| Login | displayed to recognize the object | text | yes |
| Name | displayed to recognize the object | text | no |
| displayed to recognize the object | text | no | |
| OrgLogin | context, no effect on review | text | no |
| Role | context, no effect on review | text | no |
| MembershipType | context, no effect on review | text | no |
| TwoFactorEnabled | context, no effect on review | boolean | no |
| SuspendedOn | context, no effect on review | date and time | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Organization administration: read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| OrgId | object key | integer | yes |
| Login | displayed to recognize the object | text | yes |
| Name | displayed to recognize the object | text | no |
| DefaultRepositoryPermission | context, no effect on review | text | no |
| MembersCanCreateRepos | context, no effect on review | boolean | no |
| TwoFactorRequired | context, no effect on review | boolean | no |
| CreatedOn | context, no effect on review | date and time | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Members : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| Id | object key | integer | yes |
| Login | displayed to recognize the object | text | yes |
| Name | displayed to recognize the object | text | no |
| displayed to recognize the object | text | no | |
| Scope | context, no effect on the review | text | no |
| RoleName | displayed to recognize the object | text | no |
| OrgLogin | context, no effect on the review | text | no |
| TwoFactorEnabled | context, no effect on the review | boolean | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Organization administration : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| Id | object key | integer | yes |
| TeamSlug | displayed to recognize the object | text | yes |
| TeamName | context, no effect on the review | text | no |
| OrgLogin | context, no effect on the review | text | no |
| MemberCount | context, no effect on the review | integer | no |
| GrantedOn | context, no effect on the review | date and time | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Organization projects : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| ProjectId | object key | text | yes |
| Number | context, no effect on the review | integer | no |
| Title | displayed to recognize the object | text | yes |
| Owner | access subject to review | list of identities | no |
| Public | evaluated by REVIEWIT policies (visibility) | boolean | no |
| Closed | context, no effect on the review | boolean | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Metadata : read » |
| Right | required | « Administration : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| AccessKey | object key | text | yes |
| Id | context, no effect on the review | integer | yes |
| RepoFullName | context, no effect on the review | text | yes |
| Login | displayed to recognize the object | text | yes |
| Name | displayed to recognize the object | text | no |
| Permission | context, no effect on the review | text | no |
| RoleName | displayed to recognize the object | text | no |
| IsOutsideCollaborator | context, no effect on the review | boolean | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Metadata : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| RepoId | object key | integer | yes |
| FullName | displayed to recognize the object | text | yes |
| Visibility | evaluated by REVIEWIT policies (visibility) | text | no |
| Archived | context, no effect on review | boolean | no |
| Fork | context, no effect on review | boolean | no |
| DefaultBranch | context, no effect on review | text | no |
| Owner | access subject to review | list of identities | no |
| PushedAt | evaluated by REVIEWIT policies (last activity date) | date and time | no |
| CreatedAt | context, no effect on review | date and time | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Administration : read » |
| Right | required | « Organization administration : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| RulesetId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| Target | context, no effect on review | text | no |
| Enforcement | context, no effect on review | text | no |
| RepoFullName | context, no effect on review | text | no |
| BypassActorType | context, no effect on review | text | no |
| BypassActorId | context, no effect on review | text | no |
| BypassMode | context, no effect on review | text | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Metadata : read » |
| Right | required | « Administration : read » |
| Right | required | « Members : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| AccessKey | object key | text | yes |
| Id | context, no effect on review | integer | yes |
| RepoFullName | context, no effect on review | text | yes |
| TeamSlug | context, no effect on review | text | no |
| TeamName | context, no effect on review | text | no |
| Permission | context, no effect on review | text | no |
| RoleName | displayed to recognize the object | text | yes |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Members : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| MembershipKey | object key | text | yes |
| Id | context, no effect on review | integer | yes |
| TeamSlug | context, no effect on review | text | yes |
| TeamName | context, no effect on review | text | no |
| Login | displayed to recognize the object | text | yes |
| Name | displayed to recognize the object | text | no |
| displayed to recognize the object | text | no | |
| Role | context, no effect on review | text | no |
| IsDirect | context, no effect on review | boolean | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Members : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| TeamId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| Slug | displayed to recognize the object | text | no |
| Description | context, no effect on review | text | no |
| Privacy | evaluated by REVIEWIT policies (visibility) | text | no |
| ParentTeam | context, no effect on review | text | no |
| Permission | context, no effect on review | text | no |
| MemberCount | context, no effect on review | integer | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Organization administration : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| InstallationId | object key | integer | yes |
| AppSlug | displayed to recognize the object | text | yes |
| AppName | context, no effect on review | text | no |
| TargetType | context, no effect on review | text | no |
| TargetLogin | context, no effect on review | text | no |
| RepositorySelection | context, no effect on review | text | no |
| Permissions | context, no effect on review | text | no |
| CreatedAt | context, no effect on review | date and time | no |
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
| Nature | Rule | Options |
|---|---|---|
| Right | required | « Organization personal access tokens : read » |
| Membership | required | the 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
| Field | Role | Type | Required |
|---|---|---|---|
| TokenId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| OwnerLogin | context, no effect on review | text | no |
| TokenType | context, no effect on review | text | no |
| Scopes | context, no effect on review | text | no |
| RepositorySelection | context, no effect on review | text | no |
| CreatedAt | context, no effect on review | date and time | no |
| ExpiresAt | context, no effect on review | date and time | no |
| LastUsed | evaluated by REVIEWIT policies (last activity date) | date and time | no |
20To go further #sec_889c6ab2
- Understand a collection connection
- Rights reference by resource
- Read a verdict