In this tutorial, you learn how to integrate GitHub with Azure Active Directory (Azure AD).
Integrating GitHub with Azure AD provides you with the following benefits:
- You can control in Azure AD who has access to GitHub
- You can enable your users to automatically get signed-on to GitHub (Single Sign-On) with their Azure AD accounts
- You can manage your accounts in one central location - the Azure Management portal
If you want to know more details about SaaS app integration with Azure AD, see What is application access and single sign-on with Azure Active Directory.
To configure Azure AD integration with GitHub, you need the following items:
- An Azure AD subscription
- A GitHub single-sign on enabled subscription
To test the steps in this tutorial, we do not recommend using a production environment.
To test the steps in this tutorial, you should follow these recommendations:
- You should not use your production environment, unless this is necessary.
- If you don't have an Azure AD trial environment, you can get an one-month trial here.
In this tutorial, you test Azure AD single sign-on in a test environment. The scenario outlined in this tutorial consists of two main building blocks:
- Adding GitHub from the gallery
- Configuring and testing Azure AD single sign-on
Adding GitHub from the gallery
To configure the integration of GitHub into Azure AD, you need to add GitHub from the gallery to your list of managed SaaS apps.
To add GitHub from the gallery, perform the following steps:
In the Azure Management Portal, on the left navigation panel, click Azure Active Directory icon.
Navigate to Enterprise applications. Then go to All applications.
Click Add button on the top of the dialog.
In the search box, type GitHub.com.
In the results panel, select GitHub, and then click Add button to add the application.
Configuring and testing Azure AD single sign-on
In this section, you configure and test Azure AD single sign-on with GitHub based on a test user called "Britta Simon".
For single sign-on to work, Azure AD needs to know what the counterpart user in GitHub is to a user in Azure AD. In other words, a link relationship between an Azure AD user and the related user in GitHub needs to be established.
This link relationship is established by assigning the value of the user name in Azure AD as the value of the Username in GitHub.
To configure and test Azure AD single sign-on with GitHub, you need to complete the following building blocks:
- Configuring Azure AD Single Sign-On - to enable your users to use this feature.
- Creating an Azure AD test user - to test Azure AD single sign-on with Britta Simon.
- Creating a GitHub test user - to have a counterpart of Britta Simon in GitHub that is linked to the Azure AD representation of her.
- Assigning the Azure AD test user - to enable Britta Simon to use Azure AD single sign-on.
- Testing Single Sign-On - to verify whether the configuration works.
Configuring Azure AD single sign-on
In this section, you enable Azure AD single sign-on in the Azure Management portal and configure single sign-on in your GitHub application.
To configure Azure AD single sign-on with GitHub, perform the following steps:
In the Azure Management portal, on the GitHub application integration page, click Single sign-on.
On the Single sign-on dialog, as Mode select SAML-based Sign-on to enable single sign on.
On the GitHub Domain and URLs section, perform the following steps:
a. In the Sign-on URL textbox, type the value as:
b. In the Identifier textbox, type a URL using the following pattern:
Please note that these are not the real values. You have to update these values with the actual Sing-on URL and Identifier. Here we suggest you to use the unique value of string in the Identifier. Go to GitHub Admin section to retrieve these values.
On the User Attributes section, select User Identifier as user.mail.
On the SAML Signing Certificate section, click Create new certificate.
On the Create New Certificate dialog, click the calendar icon and select an expiry date. Then click Save button.
On the SAML Signing Certificate section, select Make new certificate active and click Save button.
On the pop-up Rollover certificate window, click OK.
On the SAML Signing Certificate section, click Certificate (Base64) and then save the certificate file on your computer.
On the GitHub Configuration section, click Configure GitHub to open Configure sign-on window.
In a different web browser window, log into your GitHub organization site as an administrator.
Navigate to Settings and click Security
Check the Enable SAML authentication box, revealing the Single Sign-on configuration fields. Then, use the single sign-on URL value to update the Single sign-on URL on Azure AD configuration.
Configure the following fields:
a. Sign on URL: Enter SAML Single sign-on Service URL from the Configure GitHub section on Azure AD
b. Issuer: Enter SAML Entity ID from the Configure GitHub section on Azure AD
c. Public Certificate: Open the downloaded certificate from Azure AD in a notepad and copy the content including "BEGIN CERTIFICATE" and "END CERTIFICATE"
Click on Test SAML configuration to confirm that no validation failures or errors during SSO.
Creating an Azure AD test user
The objective of this section is to create a test user in the Azure Management portal called Britta Simon.
To create a test user in Azure AD, perform the following steps:
In the Azure Management portal, on the left navigation pane, click Azure Active Directory icon.
Go to Users and groups and click All users to display the list of users.
At the top of the dialog click Add to open the User dialog.
On the User dialog page, perform the following steps:
a. In the Name textbox, type BrittaSimon.
b. In the User name textbox, type the email address of BrittaSimon.
c. Select Show Password and write down the value of the Password.
d. Click Create.
Creating a GitHub test user
In order to enable Azure AD users to log into GitHub, they must be provisioned into GitHub.
In the case of GitHub, provisioning is a manual task.
To provision a user accounts, perform the following steps:
Log in to your GitHub company site as an administrator.
Click Invite member.
On the Invite member dialog page, perform the following steps:
a. In the Email textbox, type the email address of Britta Simon account.
b. Click Send Invitation.
The Azure Active Directory account holder will receive an email and follow a link to confirm their account before it becomes active.
Assigning the Azure AD test user
In this section, you enable Britta Simon to use Azure single sign-on by granting her access to GitHub.
To assign Britta Simon to GitHub, perform the following steps:
In the Azure Management portal, open the applications view, and then navigate to the directory view and go to Enterprise applications then click All applications.
In the applications list, select GitHub.com.
In the menu on the left, click Users and groups.
Click Add button. Then select Users and groups on Add Assignment dialog.
On Users and groups dialog, select Britta Simon in the Users list.
Click Select button on Users and groups dialog.
Click Assign button on Add Assignment dialog.
Testing single sign-on
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
When you click the GitHub tile in the Access Panel, you should get signed-on to your GitHub application. You'll be logging in as an Organization account but then need to log in with your personal account.