How To Generate Personal Access Token (PAT) in GitHub – BluBracket

Entering a Token and Creating a GitHub Personal Access Token

In order for BluBracket to access information within a given repository, an access token must be uploaded into the tenant. An administrator for the GitHub account can create a new token by taking the following steps:

Note: The user generating the Personal Access Token (PAT) should be an organization owner.

For GitHub Cloud, once logged into the GitHub interface, select Settings → Developer Settings → Personal Access Token. You should end up at a URL like this: https://github.com/settings/tokens/.
For GitHub on-prem, once logged into the GitHub interface, select Settings → Developer Settings → Personal Access Token. You should end up at a URL similar to this: <enterprise-domain>/settings/tokens/.
Click the “Generate new token” button

For GitHub cloud select the following scopes:
- These are the permissions that the token must have for BluBracket to communicate correctly with the GitHub account.

For GitHub on-premise select the following scopes:
- These are the permissions that the token must have for BluBracket to communicate correctly with the GitHub account.

See the table at the bottom of the document for scope requirements.

Click on the “Generate token” button at the bottom of the page.

This token should now be available to copy.

What permissions do we need for the Personal Access Token, and why?

Permission	Mandatory	Features	Notes
	yes	Scan and analyze private repositories Scan and analyze public repositories Read contributors per repo (access records)	The GitHub API requires having this permission even for listing repositories. Even though “Full Control of Private Repositories” is selected, BluBracket can only see/list repositories to which the user who generated the PAT has access to. Even though “Full Control of Private Repositories” is selected, BluBracket can only get the list of contributors (access records) for repositories to which the user who generated the PAT has write or admin access. BluBracket does not modify any Repo content or metadata Even though “Full Control of Private Repositories” is selected, BluBracket cannot modify the content of repositories to which the user who generated the PAT only has read access
only read:org	yes	Importing users Importing teams Need admin to see private teams and private team memberships	admin:org implies this permission
write:org, and read:org	no	Import user SAML emails Import hidden Teams	The product will work even without admin:org however the listed features will not be available
	yes	Add repo web hooks Listening to contributions Analyzing push events into repo codebases etc. Read repo web hooks Analyze for insecure hooks Analyze for non secure hooks etc.	It is not possible to modify any repo contents or metadata via a webhook - communication is only one way from provider to BluBracket. Even though “admin:repo_hook” is selected, BluBracket can only see existing webhooks, or install new webhooks for repos to to which the user who generated the PAT only has admin access
	yes	Add org level web hooks Listening to contributions Analyzing push events into repo codebases membership changes on org new repos added etc. Read org level web hooks Analyze for insecure hooks Analyze for non secure hooks etc.	It is not possible to modify any repo contents or metadata via a webhook - communication is only one way from provider to BluBracket.
	yes	Importing user information Importing user emails	BluBracket does not modify any user data

Related articles