-
Notifications
You must be signed in to change notification settings - Fork 228
DOCT-1903: clarify PAT type and add Billing Admin guidance for Snyk Essentials GitHub setup #1783
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -15,12 +15,14 @@ If you used GitHub Apps for your SCM integrations at the Snyk Organization level | |||||
| * Builds - only when using GitHub Actions. | ||||||
| * Scans - only when using Code security. | ||||||
|
|
||||||
| Ensure you meet all prerequisites listed on the [GitHub and GitHub Enterprise permission requirements](../user-permissions-and-access-scopes.md#github-and-github-enterprise-permissions-requirements) page. | ||||||
| Ensure you meet all prerequisites listed on the [GitHub for Snyk Essentials permission requirements](../user-permissions-and-access-scopes.md#github-for-snyk-essentials) page. | ||||||
|
|
||||||
| To configure a Group-level integration, you must be a Group Admin or have a custom role that includes the `Edit Snyk Essentials` permissions under the [Group-level permissions](https://app.gitbook.com/s/IgtgtomLQ2TUgSKOMSAm/user-management/pre-defined-roles#group-level-permissions). | ||||||
|
|
||||||
| ## Integrate GitHub using Snyk Essentials: <a href="#github-integrate-using-snyk-apprisk" id="github-integrate-using-snyk-apprisk"></a> | ||||||
|
|
||||||
| Snyk Essentials Group-level GitHub integrations use a classic personal access token (PAT), not a fine-grained PAT. | ||||||
|
|
||||||
| 1. Profile name (`mandatory`): Input your integration profile name. | ||||||
| 2. Organizations (`mandatory`): Input the names of all the relevant GitHub organizations. | ||||||
|
|
||||||
|
|
@@ -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 | ||||||
|
|
||||||
| {% hint style="info" %} | ||||||
| Generate the PAT from a GitHub Billing Admin account. This helps ensure Snyk Essentials can access all downstream organizations in the account and reduces the risk of the token becoming invalid when an individual user leaves the organization. | ||||||
| {% endhint %} | ||||||
|
|
||||||
| 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). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bold UI element. (Snyk style guide) Bold UI elements and settings options in procedures.
Suggested change
|
||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.