Configuring Github as an Identity Provider

The EmpowerID SSO framework allows you to register Github as an identity provider for the EmpowerID Web application. EmpowerID integrates with Github using the OAuth protocol to allow your users to log in to the EmpowerID portal using their Github account.

This topic describes how to configure an IDP connection for Github and is divided into the following activities:

As a prerequisite to creating an SSO Connection for Github as an Identity Provider, you must have a Github account and register the EmpowerID web application for your organization in the Github Developer site. This creates a set of values known by Github and the EmpowerID Web application that allow the two to enter into a federated trust relationship. These values include the Client ID and the Client Secret (these values are generated by Github), as well as the Redirect URI (this value is entered by you to tell Github where to post the assertion of a user's identity to the EmpowerID Assertion Consumer Service).

For specific directions on registering EmpowerID as an application in Github, see the information provided by Github at https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/.

When registering EmpowerID in Github, use the following URL as the Callback or Return URL, replacing "FQDN_OF_YOUR_EMPOWERID_SERVER" with the FQDN or fully resolvable DNS of the EmpowerID Web server in your environment.

https://FQDN_OF_YOUR_EMPOWERID_SERVER/EmpowerIDWebIdPForms/oauth/v2

Once the IDP Connection has been set up for Github, you can create a link similar to the one below to allow users to login to EmpowerID using Github.

Be sure to replace "FQDN_OF_YOUR_EMPOWERID_SERVER" with the FQDN or fully resolvable DNS of the EmpowerID Web server in your environment and "Github" with the name of the IDP connection you create for PayPal in EmpowerID.

 https://FQDN_OF_YOUR_EMPOWERID_SERVER/EmpowerIDWebIdPForms/Login/EmpowerIDWebSite/Github?returnUrl=%2FEmpowerIDWebIdPForms%2F

To add the Client ID and Client Secret and to the Github OAuth Connection

  1. From the Navigation Sidebar of the EmpowerID Web interface, navigate to the OAuth Application management page by expanding Admin > SSO Connections and clicking OAuth.
  2. From the OAuth Applications management page, click the OAuth Service Provider tab and then search for Github.
  3. From the OAuth Service Provider grid, click the Github link.
  4. In the External OAuth Provider Details page that appears, click the Edit button for the specific Github connection you want to edit. By default, EmpowerID includes one connection. However, you can add as many connections for Github as your organization needs.
  5. Edit links have the pencil icon

  6. In the OAuth Connection pane that appears, type the Client ID Github generated for your application in the Consumer Key field and the Secret in the Consumer Secret field.
  7. Prepend the value of the Callback Url with the FQDN of your EmpowerID Web server, using the https scheme. For example, the FQDN of the EmpowerID Web server in our environment is "sso.empowersso.com" so the full Callback Url for our site is "https://sso.empowersso.com/empoweridwebidpforms/oauth/v2".
  8. Click Save to close the OAuth Connection pane.
  9. Optionally, add any desired MFA points to the Github application by following the below steps.

To add MFA points to the Github application

  1. From the External OAuth Providers page for Github, click the Provider Edit link at the top of the page.
  2. In the MFA Point Value field, type the number of MFA points you want to give to users logging in with Github.
  3. Click Save.
  4. Next, add a login tile for Github to the desired IdP Domains. This allows your users to authenticate to EmpowerID with their Github credentials. If you have not set up an IdP Domain for your environment, you can do so by following the directions in the below drop-down.

    • To create an IdP Domain
      1. From the Navigation Sidebar, navigate to the SSO Components management page by expanding Admin > Applications and Directories > SSO Connections and clicking SSO Components.
      2. Click the IdP Domains tab and then click the Add IdP Domain (+) button.
      3. Type the fully qualified domain name in the Domain Name field and then click Save.

To add a login tile for Github

  1. From the Navigation Sidebar, navigate to the SSO Components management page by expanding Admin > Applications and Directories > SSO Connections and clicking SSO Components.
  2. From the IdP Domains tab of the SSO Components page, click the link for the IdP Domain to which you want to add the login tile.
  3. In the IdP Domain Details page that appears, click the External OAuth Providers tab and check the Github beside Github.
  4. Click Save.
  5. To give users the ability to log in using their EmpowerID credentials, be sure to select EmpowerID from the SAML Identity Providers tab of the IdP Domain Details page.

    Now that the IDP Connection is configured, you can test it by following the procedure outlined below.

To test the Github connection

  1. From the Navigation Sidebar, navigate to the Workflows page by expanding IT Shop and clicking Workflows.
  2. From the Workflows page, recycle the EmpowerID App Pools by clicking Recycle EmpowerID App Pools.
  3. Log out of the EmpowerID Web interface and navigate your browser to the domain name you configured for the Github IdP connection.
  4. Click the Login using Github button.
  5. This redirects your browser to the Github Login for the EmpowerID web application you created in Github. Enter your Github credentials and click Sign in.
  6. Click Authorize
  7. Back in the EmpowerID Web interface, click Yes to indicate that you have an EmpowerID login.
  8. Users without EmpowerID Persons can request EmpowerID accounts by clicking No. This initiates the Create User Account workflow, which displays a form in the browser to allow the user to fill in the appropriate information. If a user submits the request, EmpowerID routes that request to those individuals in your environment with the ability to approve or deny the request and returns the user to the EmpowerID web login.
  9. Type your EmpowerID Login or Email in the form and click Submit. The EmpowerID Person must have a valid email address as EmpowerID sends a one-time password to that address.
  10. Check your email for the one-time password.
  11. Back in the EmpowerID Web interface, type the one-time password into the Password field of the One-Time Password Validation form and click Submit.
Upon successful submission of your one-time password, EmpowerID logs the user in and joins the Github account to their EmpowerID Person account.
If you have set up the user's Password Manager policy to require the user accumulate a specific number of trust points beyond those granted by the identity provider, EmpowerID will direct the user through any Multi-factor methods you have enabled on the policy until they reach the needed point threshold to log in.