GitHub Application Integration Setup

Getting started

BalkanID recommends creating a separate service account for the purposes of this integration, instead of using personal or employee named accounts.

Requirements

• Personal Access Token

• Organization Name

Getting your Configuration

To connect your GitHub account, you’ll need to create a Personal Access Token (PAT). GitHub offers two types of tokens:

• Fine-grained tokens (Recommended)

• Classic tokens

Option 1: Fine-Grained Personal Access Token (Recommended)

Fine-grained tokens provide better security and more control over access.

Steps

1. Go to GitHub Settings → Developer Settings → Personal Access Tokens → Fine-grained tokens

2. Click Generate new token

3. Select the organization you want to integrate

4. Under Repository access:

   • Choose All repositories (recommended for complete data visibility)

   • If selecting specific repositories, ensure you include all repositories you want reflected in the dashboard

5. Enable the following repository permissions:

Permission	Access level
Metadata	Read
Administration	Read

1. Enable the following Organization permissions:

Permission	Access level
Members	Read

In addition to the Permissions listed above, the following permissions must be enabled to ensure discovery of Github Credentials.

Enable the following Organization permissions:

Permission	Access level
Admin	Read

Option 2: Classic Personal Access Token

If you prefer using a classic token:

Steps

1. Go to GitHub Settings → Developer Settings → Personal Access Tokens → Tokens (classic)

2. Click Generate new token

3. Select the required scopes as shown in the reference image

Authorizing a personal access token for use with SAML single sign-on

To use a personal access token (classic) with an organization that uses SAML single sign-on (SSO), you must first authorize the token.

For the personal access token, you'd like to authorize, click Configure SSO. If you don't see Configure SSO, ensure that you have authenticated at least once through your SAML IdP to access resources on GitHub.com. For more information, see "About authentication with SAML single sign-on."

More details here.

Configure GitHub in your BalkanID tenant

1. Login to the BalkanID application and switch to the tenant you would like to add your integration to.

2. Head to Integrations > Add Integration, select Github.

   

   
3. Set up the Primary Application owner (mandatory) and the Description, if any. Set up Secondary Application Owner(s), if any.

   Select the Extraction Type. From here, you can configure your application using one of the following methods:

   1. Direct integration - Provide your Github Personal Access Token and Organization obtained above to set up a direct connection with BalkanID.

   2. SCIM integration - Provide SCIM server credentials to set up a SCIM connection with BalkanID.

   3. Manual file upload - Upload Entity and Entity Relations through a .CSV file upload. Contact the team for assistance with this.

   4. Automated upload using API - You can upload data using our Bulk APIs with the help of an API key which will be provided to you. Please refer to the entity and entity relation upload docs for specific instructions on uploading your data through the API.

   
4. Click on next to move onto Optional Configuration.

5. Fill Optional configuration, if required.

   
6. Once you filled in the information, click Save. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status will read Connected and the integration Message will read Data available.

Integration Scopes

Read Only (Access Review) Scopes	Lifecycle Management Scopes
repo	repo
write:packages -> read:packages	write:packages -> read:packages
admin:org -> read:org	admin:org
admin:public_key -> read:public_key	admin:public_key -> read:public_key
admin:repo_hook -> read:repo_hook	admin:repo_hook -> read:repo_hook
user	user
admin:enterprise -> read:enterprise	admin:enterprise
audit_log	audit_log
project	project