GitHub

This guide will teach you how to set up the connector between Github and Clarity Security.

Estimated time to complete: 10 minutes

Below are capabilities supported by the connector at this time.

How to Setup the Connector

Step 1: Navigate to Connector

Head to the following link to connect Github with your Clarity Security tenant.

https://github.com/apps/clarity-security-github-connector

Step 2: Click Install

Click the install button to install the application to your GitHub organization.

Step 3: Select your GitHub Organization

Choose the organization that you wish to connect to your clarity tenant.

Step 4: Determine your app installation id

If you are not redirected automatically to a page listing the installation id for the application (see link below), you will want to navigate to the settings page for your organization, and click on the Third-party Access, then GitHub Apps.

https://github.com/organizations/YOUR_ORG_NAME/settings/installations/XXXXXXXXX

If you already got your installation id (example in the URL above), you can skip to Step 7.

Step 5: Click Configure

Click the Configure button for the Clarity Security GitHub Connector.

Step 6: Grab the installation id

Once you click configure, the URL at the top of the page should look similar to the one listed below, where the "XXXXXXXXX" represents the series of numbers for your app installation id.  Copy this value for use in a later step.

https://github.com/organizations/YOUR_ORG_NAME/settings/installations/XXXXXXXXX

Step 7: Log in to Clarity

Login to your Clarity Security tenant.

https://your_tenant.claritysecurity.io

Step 8: Click on Applications, then Marketplace

Step 9: Find GitHub

Scroll to or search for Github in the list of applications from the marketplace, then click Connect.

Step 10: Connect App

Complete the App Settings form.  Details for fields common to all applications can be found in the following article: Common App Configuration Steps.

• app_installation_id: Paste the value obtained from either Step 4 or Step 6.

Step 11: App Settings

Complete the App Settings form.  Details for each field can be found in the following article: Common App Configuration Steps.

Step 12: User Settings

Complete the User Settings form, check the table at the top to see if any features are unsupported.  Details for each field can be found in the following article: Common App Configuration Steps.

Step 13: Validate Your Selections and Save

Need Help?