DOCT-1903: clarify PAT type and add Billing Admin guidance for Snyk Essentials GitHub setup - #1783
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
AI review
The technical facts hold up and the guidance clarifies the token requirements for Snyk Essentials. I verified the target anchor #github-for-snyk-essentials in developer-tools/scm-integrations/user-permissions-and-access-scopes.md and confirmed all relative links resolve.
No structural defects found. I have included two minor style recommendations below as one-click suggestions.
Style fixes (folded into the suggestions)
Apply sentence case to the PAT generation heading · bold the UI element Personal access tokens in the PAT instructions.
One thing to confirm
user-permissions-and-access-scopes.md will also need alignment once confirmed.
Sent by Cursor Automation: PR review for User Docs
| @@ -48,6 +50,10 @@ If you want to pull data from both organization and personal repositories, then | |||
|
|
|||
| ## Generate a Personal access token from your GitHub settings | |||
There was a problem hiding this comment.
Use sentence case for heading. (Snyk style guide)
Capitalize only the first word and proper nouns in headings. "Personal" is a common noun in this context.
| ## Generate a Personal access token from your GitHub settings | |
| ## Generate a personal access token from your GitHub settings |
|
|
||
| 1. Open GitHub and click the Settings menu for your profile. | ||
| 2. Select Developer settings from the left sidebar. | ||
| 3. Select Personal access tokens and then Tokens (classic). |
There was a problem hiding this comment.
Bold UI element. (Snyk style guide)
Bold UI elements and settings options in procedures.
| 3. Select Personal access tokens and then Tokens (classic). | |
| 3. Select **Personal access tokens** and then **Tokens (classic)**. |
…ssentials GitHub setup
bba1638 to
168532b
Compare


Related ticket
DOCT-1903
What changed
On
GitHub for Snyk Essentials:Out of scope for this PR
The requester (Jamie Meredith) confirmed the eng team needs to weigh in on how the PAT's permissions are actually used before we can accurately describe them, specifically:
reposcope's write access is used by Essentials at all.These are being tracked in a follow-up Jira ticket rather than blocking this PR. The permissions reference page (
user-permissions-and-access-scopes.md#github-for-snyk-essentials) also needs a matching update but is handled separately once that's resolved.Note
Low Risk
Documentation-only changes to integration setup guidance; no product code or security logic is modified.
Overview
Updates GitHub for Snyk Essentials setup docs so admins use the right token type and account, and land on the correct permissions page.
The integration section now states upfront that Group-level GitHub integrations require a classic PAT, not a fine-grained PAT. The PAT generation section adds guidance to create the token from a GitHub Billing Admin account so Essentials can reach downstream orgs in the account and the token is less likely to break when a user leaves.
The prerequisites link now targets GitHub for Snyk Essentials permission requirements instead of the generic GitHub Enterprise org-level section.
Reviewed by Cursor Bugbot for commit 168532b. Bugbot is set up for automated code reviews on this repo. Configure here.