Skip to main content

GitHub Enterprise Server

Connector maturity: Beta. See Connector maturity.

Description​

The GitHub Enterprise Server connector uses the GitHub REST API to discover organisation members, team memberships, and repository permissions within a self-hosted GitHub Enterprise Server (GHES) instance. It authenticates using a Personal Access Token (PAT) and provides visibility into developer and service account access across organisations and repositories.

System Type Classification​

FieldValue
System TypeApplication
Default Scan Priority500

Version Support​

OrbisID EditionSupported
CommunityNo
ProYes
EnterpriseYes

Supported Protocol​

ProtocolPortNotes
REST API (HTTPS)443 TCPPersonal Access Token (PAT) via Authorization: Bearer header

What OrbisID Discovers​

DataSource
Organisation membersGET /api/v3/orgs/{org}/members
TeamsGET /api/v3/orgs/{org}/teams
Team membershipsGET /api/v3/teams/{id}/members
Organisation rolesrole field per member (member, admin)
Outside collaboratorsGET /api/v3/orgs/{org}/outside_collaborators

Connection Requirements​

Required Permissions​

Create a dedicated service account and generate a PAT with the required scopes.

Minimum PAT scopes:

  • read:org — read organisation memberships and team structures
  • read:user — read user profile information

Credential Mapping​

OrbisID FieldValue
credential.passwordPersonal Access Token (PAT)
system.hostnameGHES hostname (e.g., github.example.com)

Personal Access Token Metadata​

With the githubCollectTokens system attribute on, each scan reads the fine-grained personal access tokens that have been granted access to each organisation (GET /orgs/{org}/personal-access-tokens) and records, for the member who owns each one, its name, when access was granted, when it expires and when it was last used. The token itself is never read. This needs an API token that may read the organisation's personal access tokens and a GitHub version that offers the list; if it cannot be read, the scan continues with a warning and the tokens already recorded are kept. Off by default.

GitHub Actions Secrets​

With the githubCollectActionsSecrets system attribute on, each scan lists the names and last-updated dates of GitHub Actions secrets: organisation secrets, repository secrets and the secrets of each repository's environments. Secret values are never read (GitHub does not return them). Each organisation or repository that has at least one secret appears as a Non-Human account named github-actions:<org> or github-actions:<org>/<repo>, holding its secrets as CI/CD secret credentials. The last-updated date is when the value was last set, so it is shown as the last rotation, and the credential KRIs and credential policy rules apply to them. The secrets are also compared with your vault on the Secrets Outside Vault page.

The API token needs to read Actions secrets:

Secrets readClassic token scopeFine-grained token permission
Organisation secretsadmin:orgOrganisation: Secrets (read)
Repository and environment secretsrepoRepository: Secrets (read), Environments (read)

Costs at least two API calls per repository (more for each environment), and at most 1,000 repositories per organisation are checked. If any list cannot be read (for example a repository the token cannot see), the scan continues with a warning, and secrets already recorded are kept rather than removed. Off by default.

Other CI/CD systems that keep secrets outside a vault (GitLab CI/CD variables, Azure DevOps variable groups, Jenkins credentials, CircleCI contexts, Bitbucket Pipelines variables) are not read yet.

Network Requirements​

The OrbisID server must have HTTPS access to the GitHub Enterprise Server on port 443.

Configuration Steps​

  1. In GitHub Enterprise Server, create a dedicated service account user
  2. Generate a Personal Access Token: Settings → Developer settings → Personal access tokens
  3. Grant read:org and read:user scopes
  4. Create a Credential in OrbisID:
    • Password: Personal Access Token
  5. Navigate to Systems → Add System
  6. Fill in the fields:
FieldValue
NameDescriptive name (e.g., GitHub Enterprise – Engineering)
OS TypeGitHubEnterprise
System TypeApplication
HostnameGHES hostname
CredentialThe PAT credential
  1. Click Test Connection
  2. Click Save

Troubleshooting​

SymptomLikely CauseResolution
401 UnauthorizedInvalid or expired PATRegenerate the Personal Access Token
No organisations returnedPAT missing read:org scopeRegenerate PAT with the correct scopes
403 ForbiddenOrganisation SSO not authorisedAuthorise the PAT for SAML SSO in the organisation settings
Cannot connectGHES not reachableVerify HTTPS connectivity on port 443