GitHub¶
Identity & SaaS audit logs. Organization audit-log events: access, secrets, and repo changes.
GitHub Enterprise Cloud required
This integration requires an organization on GitHub Enterprise Cloud. GitHub Free and Team organizations are not supported because GitHub only exposes the organization audit-log API on Enterprise Cloud.
Status: available now - you connect this yourself
This source is live in the console. Create the read-only credential below, connect it on its card in Integrate -> Sources, and your dedicated instance starts collecting.
What SheerSight reads¶
SheerSight reads your organization audit log: repositories made public, two-factor requirements changed, new personal access tokens / runners / deploy keys, branch-protection and secret tampering, and unusual actor volume.
That feed powers detections such as a repo made public, 2FA requirement disabled, a persistence credential being added (new PAT, deploy key, or runner), integrity tampering (branch protection or secret changes), and an actor activity burst.
It is read-only, and it never reads your repository contents.
What you'll need¶
- An organization on GitHub Enterprise Cloud.
- A GitHub organization owner to create the token.
- Your dedicated instance enrolled.
Create the read-only credential¶
You only need a token with audit-log read and nothing else. Either token type works.
- As an org owner, go to GitHub -> your avatar -> Settings -> Developer settings -> Personal access tokens -> Fine-grained tokens -> Generate new token.
- Set Resource owner to your organization.
- Under Organization permissions, grant Administration: Read-only. Grant no repository permissions.
- Generate the token and copy it.
- Go to Settings -> Developer settings -> Personal access tokens -> Tokens (classic) -> Generate new token.
- Select only the
read:audit_logscope. Select no other scopes. - Generate the token and copy it.
Least privilege
Audit-log read grants no write access and no access to repository contents. That is the only permission SheerSight needs.
Connect it in SheerSight¶
In the console, open Integrate -> Sources -> GitHub and fill in:
| Field | Value |
|---|---|
| Organization | Your organization slug (the name in github.com/<org>). |
| Personal access token | The token you created above. |
Press Connect.
Verify¶
- The relayed credentials entry moves from pending to applied.
- The GitHub source badge moves from not connected to live.
- Audit events begin appearing, and matching detections start firing.
Spot-check the first backfill
Compare the count and time range of the first poll against your org's own audit log (Organization -> Settings -> Logs -> Audit log) for the same window.
Troubleshooting¶
- Badge stays not connected. Re-check that the token has audit-log read, and that the organization slug is spelled exactly as in your GitHub URL.
- 401 / unauthorized. The token is wrong, expired, or lacks audit-log read. Regenerate it.
- 404 / not found on every poll. This almost always means the organization is not on GitHub Enterprise Cloud. Check under Organization -> Settings -> Billing and plans. A wrong organization name is the other cause.
- Status shows "not enabled" after you upgraded to Enterprise Cloud. SheerSight checks the plan again every 6 hours, so it can take up to that long to start collecting. Reconnect GitHub from the console to make it check right away.
What SheerSight can and cannot do¶
The token is read-only and scoped to the audit log. SheerSight cannot change org or repo settings, read code, manage members, or take any action. It only reads audit events.