Tutorial: Azure Active Directory single sign-on (SSO) integration with a GitHub Enterprise Cloud Organization
In this tutorial, you'll learn how to integrate a GitHub Enterprise Cloud Organization with Azure Active Directory (Azure AD). When you integrate a GitHub Enterprise Cloud Organization with Azure AD, you can:
- Control in Azure AD who has access to your GitHub Enterprise Cloud Organization.
- Manage access to your GitHub Enterprise Cloud Organization in one central location - the Azure portal.
To learn more 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 a GitHub Enterprise Cloud Organization, you need the following items:
- An Azure AD subscription. If you don't have an Azure AD environment, you can get one-month trial here
- A GitHub organization created in GitHub Enterprise Cloud, which requires the GitHub Enterprise billing plan
In this tutorial, you configure and test Azure AD single sign-on in a test environment.
GitHub supports SP initiated SSO
GitHub supports Automated user provisioning (organization invitations)
Once you configure GitHub you can enforce Session control, which protects exfiltration and infiltration of your organization’s sensitive data in real time. Session control extends from Conditional Access. Learn how to enforce session control with Microsoft Cloud App Security
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.
- Sign in to the Azure portal using either a work or school account, or a personal Microsoft account.
- On the left navigation pane, select the Azure Active Directory service.
- Navigate to Enterprise Applications and then select All Applications.
- To add new application, select New application.
- In the Add from the gallery section, type GitHub in the search box.
- Select GitHub Enterprise Cloud - Organization from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
Configure and test Azure AD single sign-on for GitHub
Configure and test Azure AD SSO with GitHub using a test user called B.Simon. For SSO to work, you need to establish a link relationship between an Azure AD user and the related user in GitHub.
To configure and test Azure AD SSO with GitHub, complete the following building blocks:
- Configure Azure AD SSO - to enable your users to use this feature.
- Configure GitHub SSO - to configure the single sign-on settings on application side.
- Create GitHub test user - to have a counterpart of B.Simon in GitHub that is linked to the Azure AD representation of user.
- Test SSO - to verify whether the configuration works.
Configure Azure AD SSO
Follow these steps to enable Azure AD SSO in the Azure portal.
In the Azure portal, on the GitHub application integration page, find the Manage section and select single sign-on.
On the Select a single sign-on method page, select SAML.
On the Set up single sign-on with SAML page, click the edit/pen icon for Basic SAML Configuration to edit the settings.
On the Basic SAML Configuration section, enter the values for the following fields:
a. In the Sign on URL text box, type a URL using the following pattern:
b. In the Identifier (Entity ID) text box, type a URL using the following pattern:
c. In the Reply URL text box, 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 Sign on URL, Identifier and Reply URL. Here we suggest you to use the unique value of string in the Identifier. Go to GitHub Admin section to retrieve these values.
Your GitHub application expects the SAML assertions in a specific format, which requires you to add custom attribute mappings to your SAML token attributes configuration. The following screenshot shows the list of default attributes, where as Unique User Identifier (Name ID) is mapped with user.userprincipalname. GitHub application expects Unique User Identifier (Name ID) to be mapped with user.mail, so you need to edit the attribute mapping by clicking on Edit icon and change the attribute mapping.
On the Set up Single Sign-On with SAML page, in the SAML Signing Certificate section, click Download to download the Certificate (Base64) from the given options as per your requirement and save it on your computer.
On the Set up GitHub section, copy the appropriate URL(s) as per your requirement.
a. Login URL
b. Azure Ad Identifier
c. Logout URL
Create an Azure AD test user
In this section, you'll create a test user in the Azure portal called B.Simon.
- From the left pane in the Azure portal, select Azure Active Directory, select Users, and then select All users.
- Select New user at the top of the screen.
- In the User properties, follow these steps:
- In the Name field, enter
- In the User name field, enter the firstname.lastname@example.org. For example,
- Select the Show password check box, and then write down the value that's displayed in the Password box.
- Click Create.
- In the Name field, enter
Assign the Azure AD test user
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to GitHub.
In the Azure portal, select Enterprise Applications, and then select All applications.
In the applications list, select GitHub.
In the app's overview page, find the Manage section and select Users and groups.
Select Add user, then select Users and groups in the Add Assignment dialog.
In the Users and groups dialog, select B.Simon from the Users list, then click the Select button at the bottom of the screen.
If you're expecting any role value in the SAML assertion, in the Select a role dialog, select the appropriate role for the user from the list and then click the Select button at the bottom of the screen.
Select a role option will be disabled and default role is USER for selected user.
In the Add Assignment dialog, click the Assign button.
Configure GitHub SSO
In a different web browser window, sign 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. perform the following steps:
a. Copy single sign-on URL value and paste this value into the Sign on URL text box in the Basic SAML Configuration in the Azure portal.
b. Copy assertion consumer service URL value and paste this value into the Reply URL text box in the Basic SAML Configuration in the Azure portal.
Configure the following fields:
a. In the Sign on URL textbox, paste Login URL value which you have copied from the Azure portal.
b. In the Issuer textbox, paste Azure AD Identifier value which you have copied from the Azure portal.
c. Open the downloaded certificate from Azure portal in notepad, paste the content into the Public Certificate textbox.
d. Click on Edit icon to edit the Signature Method and Digest Method from RSA-SHA1 and SHA1 to RSA-SHA256 and SHA256 as shown below.
e. Update the assertion consumer service URL (Reply URL) from the default URL so that it the URL in GitHub matches the URL in the Azure app registration.
Click on Test SAML configuration to confirm that no validation failures or errors during SSO.
Single sign-on in GitHub authenticates to a specific organization in GitHub and does not replace the authentication of GitHub itself. Therefore, if the user's github.com session has expired, you may be asked to authenticate with GitHub's ID/password during the single sign-on process.
Create GitHub test user
The objective of this section is to create a user called Britta Simon in GitHub. GitHub supports automatic user provisioning, which is by default enabled. You can find more details here on how to configure automatic user provisioning.
If you need to create user manually, perform 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.
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 be automatically signed in to the GitHub for which you set up SSO. For more information about the Access Panel, see Introduction to the Access Panel.