GitHub is the best place to share code with friends, co-workers, classmates, and complete strangers. Over 31 million people use GitHub to build amazing things together across 97+ million repositories. With all the collaborative features of GitHub, it has never been easier for individuals and teams to write faster, better code.

Authenticating

GitHub uses OAuth, a developer-friendly delegated access protocol. Quolum has already connected the necessary wires with GitHub. Using a sequence of click-throughs, your organization's administrator allows Quolum to make API calls to GitHub without getting access to passwords.

Step 1: Initiate a connection to GitHub

Click the Connect button from the Connections card. If you are not an admin, you can invite your organization's GitHub admin to make a connection to your GitHub organization account. When you click on the Connect button, the web browser will navigate to the GitHub login page.

23192319

Quolum Catalog: GitHub App

Step 2: Log in to GitHub

Log in to GitHub using your organization's credentials. The exact login mechanism may depend on your GitHub plan, and the sign-in mechanism used. You may have corporate SSO such as Azure AD, GSuite, or Okta along with multi-factor authentication. Once you have successfully logged-in, GitHub is going to ask you to grant access to Quolum.

28792879

GitHub Authentication

Step 3: Provide consent to Quolum

The next screen after login into GitHub is the consent screen. On this screen, GitHub confirms whether you authorize Quolum to access your organization's data.

Step 4: Back to Quolum

Once you have granted access to Quolum on GitHub's website, GitHub is going to send you back to Quolum's page in Step 1, where you started. The Connect button on the Connections card would now say Reconnect. Reconnect is used to reauthenticate under circumstances where the access has expired.

Under the hood

Using the OAuth protocol, Quolum now has delegated access to your GitHub Workspace. The Quolum server, running on Amazon AWS VPC, will be able to make API calls and retrieve feature-level utilization of projects, stories, and tasks. Later, this data is crunched and available for visualization on the Quolum dashboard.