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
| Field | Value |
|---|---|
| System Type | Application |
| Default Scan Priority | 500 |
Version Support
| OrbisID Edition | Supported |
|---|---|
| Community | No |
| Pro | Yes |
| Enterprise | Yes |
Supported Protocol
| Protocol | Port | Notes |
|---|---|---|
| REST API (HTTPS) | 443 TCP | Personal Access Token (PAT) via Authorization: Bearer header |
What OrbisID Discovers
| Data | Source |
|---|---|
| Organisation members | GET /api/v3/orgs/{org}/members |
| Teams | GET /api/v3/orgs/{org}/teams |
| Team memberships | GET /api/v3/teams/{id}/members |
| Organisation roles | role field per member (member, admin) |
| Outside collaborators | GET /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 structuresread:user— read user profile information
Credential Mapping
| OrbisID Field | Value |
|---|---|
credential.password | Personal Access Token (PAT) |
system.hostname | GHES 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 read | Classic token scope | Fine-grained token permission |
|---|---|---|
| Organisation secrets | admin:org | Organisation: Secrets (read) |
| Repository and environment secrets | repo | Repository: 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
- In GitHub Enterprise Server, create a dedicated service account user
- Generate a Personal Access Token: Settings → Developer settings → Personal access tokens
- Grant
read:organdread:userscopes - Create a Credential in OrbisID:
- Password: Personal Access Token
- Navigate to Systems → Add System
- Fill in the fields:
| Field | Value |
|---|---|
| Name | Descriptive name (e.g., GitHub Enterprise – Engineering) |
| OS Type | GitHubEnterprise |
| System Type | Application |
| Hostname | GHES hostname |
| Credential | The PAT credential |
- Click Test Connection
- Click Save
Troubleshooting
| Symptom | Likely Cause | Resolution |
|---|---|---|
401 Unauthorized | Invalid or expired PAT | Regenerate the Personal Access Token |
| No organisations returned | PAT missing read:org scope | Regenerate PAT with the correct scopes |
403 Forbidden | Organisation SSO not authorised | Authorise the PAT for SAML SSO in the organisation settings |
| Cannot connect | GHES not reachable | Verify HTTPS connectivity on port 443 |