Skip to content

Commit 921e1ad

Browse files
authored
Merge pull request #49790 from v-nagta/githubupdate
Product Backlog Item 530554: SaaS App Tutorial: GitHub update
2 parents ba0259b + 938aeeb commit 921e1ad

File tree

1 file changed

+46
-44
lines changed

1 file changed

+46
-44
lines changed

articles/active-directory/saas-apps/github-tutorial.md

Lines changed: 46 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
title: 'Tutorial: Azure Active Directory integration with GitHub | Microsoft Docs'
33
description: Learn how to configure single sign-on between Azure Active Directory and GitHub.
44
services: active-directory
@@ -14,7 +14,7 @@ ms.workload: identity
1414
ms.tgt_pltfrm: na
1515
ms.devlang: na
1616
ms.topic: article
17-
ms.date: 05/16/2018
17+
ms.date: 08/23/2018
1818
ms.author: jeedes
1919

2020
---
@@ -46,13 +46,15 @@ To test the steps in this tutorial, you should follow these recommendations:
4646
- If you don't have an Azure AD trial environment, you can [get a one-month trial](https://azure.microsoft.com/pricing/free-trial/).
4747

4848
## Scenario description
49+
4950
In this tutorial, you test Azure AD single sign-on in a test environment.
5051
The scenario outlined in this tutorial consists of two main building blocks:
5152

5253
1. Adding GitHub from the gallery
53-
1. Configuring and testing Azure AD single sign-on
54+
2. Configuring and testing Azure AD single sign-on
5455

5556
## Adding GitHub from the gallery
57+
5658
To configure the integration of GitHub into Azure AD, you need to add GitHub from the gallery to your list of managed SaaS apps.
5759

5860
**To add GitHub from the gallery, perform the following steps:**
@@ -61,15 +63,15 @@ To configure the integration of GitHub into Azure AD, you need to add GitHub fro
6163

6264
![The Azure Active Directory button][1]
6365

64-
1. Navigate to **Enterprise applications**. Then go to **All applications**.
66+
2. Navigate to **Enterprise applications**. Then go to **All applications**.
6567

6668
![The Enterprise applications blade][2]
67-
68-
1. To add new application, click **New application** button on the top of dialog.
69+
70+
3. To add new application, click **New application** button on the top of dialog.
6971

7072
![The New application button][3]
7173

72-
1. In the search box, type **GitHub**, select **GitHub** from result panel then click **Add** button to add the application.
74+
4. In the search box, type **GitHub**, select **GitHub** from result panel then click **Add** button to add the application.
7375

7476
![GitHub in the results list](./media/github-tutorial/tutorial_github_addfromgallery.png)
7577

@@ -82,10 +84,10 @@ For single sign-on to work, Azure AD needs to know what the counterpart user in
8284
To configure and test Azure AD single sign-on with GitHub, you need to complete the following building blocks:
8385

8486
1. **[Configure Azure AD Single Sign-On](#configure-azure-ad-single-sign-on)** - to enable your users to use this feature.
85-
1. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
86-
1. **[Create a GitHub test user](#create-a-github-test-user)** - to have a counterpart of Britta Simon in GitHub that is linked to the Azure AD representation of user.
87-
1. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
88-
1. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
87+
2. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
88+
3. **[Create a GitHub test user](#create-a-github-test-user)** - to have a counterpart of Britta Simon in GitHub that is linked to the Azure AD representation of user.
89+
4. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
90+
5. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
8991

9092
### Configure Azure AD single sign-on
9193

@@ -97,11 +99,11 @@ In this section, you enable Azure AD single sign-on in the Azure portal and conf
9799

98100
![Configure single sign-on link][4]
99101

100-
1. On the **Single sign-on** dialog, select **Mode** as **SAML-based Sign-on** to enable single sign-on.
101-
102+
2. On the **Single sign-on** dialog, select **Mode** as **SAML-based Sign-on** to enable single sign-on.
103+
102104
![Single sign-on dialog box](./media/github-tutorial/tutorial_github_samlbase.png)
103105

104-
1. On the **GitHub Domain and URLs** section, perform the following steps:
106+
3. On the **GitHub Domain and URLs** section, perform the following steps:
105107

106108
![GitHub Domain and URLs single sign-on information](./media/github-tutorial/tutorial_github_url.png)
107109

@@ -112,47 +114,50 @@ In this section, you enable Azure AD single sign-on in the Azure portal and conf
112114
> [!NOTE]
113115
> Please note that these are not the real values. You have to update these values with the actual Sign 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.
114116

115-
1. On the **User Attributes** section, select **User Identifier** as user.mail.
117+
4. On the **User Attributes** section, select **User Identifier** as user.mail.
116118

117119
![Configure Single Sign-On](./media/github-tutorial/tutorial_github_attribute_new01.png)
118120

119-
1. On the **SAML Signing Certificate** section, click **Certificate (Base64)** and then save the certificate file on your computer.
121+
5. On the **SAML Signing Certificate** section, click **Certificate (Base64)** and then save the certificate file on your computer.
120122

121123
![The Certificate download link](./media/github-tutorial/tutorial_github_certificate.png)
122124

123-
1. Click **Save** button.
125+
6. Click **Save** button.
124126

125127
![Configure Single Sign-On Save button](./media/github-tutorial/tutorial_general_400.png)
126128

127-
1. On the **GitHub Configuration** section, click **Configure GitHub** to open **Configure sign-on** window. Copy the **Sign-Out URL, SAML Entity ID, and SAML Single Sign-On Service URL** from the **Quick Reference section.**
129+
7. On the **GitHub Configuration** section, click **Configure GitHub** to open **Configure sign-on** window. Copy the **Sign-Out URL, SAML Entity ID, and SAML Single Sign-On Service URL** from the **Quick Reference section.**
128130

129131
![GitHub Configuration](./media/github-tutorial/tutorial_github_configure.png)
130132

131-
1. In a different web browser window, log into your GitHub organization site as an administrator.
133+
8. In a different web browser window, log into your GitHub organization site as an administrator.
132134

133-
1. Navigate to **Settings** and click **Security**
135+
9. Navigate to **Settings** and click **Security**
134136

135137
![Settings](./media/github-tutorial/tutorial_github_config_github_03.png)
136138

137-
1. 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.
139+
10. 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.
138140

139141
![Settings](./media/github-tutorial/tutorial_github_config_github_13.png)
140142

141-
1. Configure the following fields:
143+
11. Configure the following fields:
142144

143145
a. In the **Sign on URL** textbox, paste **SAML Single sign-on Service URL** value which you have copied from the Azure portal.
144146

145147
b. In the **Issuer** textbox, paste **SAML Entity ID** value which you have copied from the Azure portal.
146148

147-
c. Open the downloaded certificate from Azure portal in notepad, paste the content into the **Public Certificate** textbox.
149+
c. Open the downloaded certificate from Azure portal in notepad, paste the content into the **Public Certificate** textbox.
148150

149151
![Settings](./media/github-tutorial/tutorial_github_config_github_051.png)
150152

151-
1. Click on **Test SAML configuration** to confirm that no validation failures or errors during SSO.
153+
12. Click on **Test SAML configuration** to confirm that no validation failures or errors during SSO.
152154

153155
![Settings](./media/github-tutorial/tutorial_github_config_github_06.png)
154156

155-
1. Click **Save**
157+
13. Click **Save**
158+
159+
> [!NOTE]
160+
> 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.
156161
157162
### Create an Azure AD test user
158163

@@ -166,15 +171,15 @@ The objective of this section is to create a test user in the Azure portal calle
166171

167172
![The Azure Active Directory button](./media/github-tutorial/create_aaduser_01.png)
168173

169-
1. To display the list of users, go to **Users and groups**, and then click **All users**.
174+
2. To display the list of users, go to **Users and groups**, and then click **All users**.
170175

171176
![The "Users and groups" and "All users" links](./media/github-tutorial/create_aaduser_02.png)
172177

173-
1. To open the **User** dialog box, click **Add** at the top of the **All Users** dialog box.
178+
3. To open the **User** dialog box, click **Add** at the top of the **All Users** dialog box.
174179

175180
![The Add button](./media/github-tutorial/create_aaduser_03.png)
176181

177-
1. In the **User** dialog box, perform the following steps:
182+
4. In the **User** dialog box, perform the following steps:
178183

179184
![The User dialog box](./media/github-tutorial/create_aaduser_04.png)
180185

@@ -185,7 +190,7 @@ The objective of this section is to create a test user in the Azure portal calle
185190
c. Select the **Show Password** check box, and then write down the value that's displayed in the **Password** box.
186191

187192
d. Click **Create**.
188-
193+
189194
### Create a GitHub test user
190195

191196
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](github-provisioning-tutorial.md) on how to configure automatic user provisioning.
@@ -194,15 +199,15 @@ The objective of this section is to create a user called Britta Simon in GitHub.
194199

195200
1. Log in to your GitHub company site as an administrator.
196201

197-
1. Click **People**.
202+
2. Click **People**.
198203

199204
![People](./media/github-tutorial/tutorial_github_config_github_08.png "People")
200205

201-
1. Click **Invite member**.
206+
3. Click **Invite member**.
202207

203208
![Invite Users](./media/github-tutorial/tutorial_github_config_github_09.png "Invite Users")
204209

205-
1. On the **Invite member** dialog page, perform the following steps:
210+
4. On the **Invite member** dialog page, perform the following steps:
206211

207212
a. In the **Email** textbox, type the email address of Britta Simon account.
208213

@@ -227,38 +232,36 @@ In this section, you enable Britta Simon to use Azure single sign-on by granting
227232

228233
![Assign User][201]
229234

230-
1. In the applications list, select **GitHub**.
235+
2. In the applications list, select **GitHub**.
231236

232237
![The GitHub link in the Applications list](./media/github-tutorial/tutorial_github_app.png)
233238

234-
1. In the menu on the left, click **Users and groups**.
239+
3. In the menu on the left, click **Users and groups**.
235240

236241
![The "Users and groups" link][202]
237242

238-
1. Click **Add** button. Then select **Users and groups** on **Add Assignment** dialog.
243+
4. Click **Add** button. Then select **Users and groups** on **Add Assignment** dialog.
239244

240245
![The Add Assignment pane][203]
241246

242-
1. On **Users and groups** dialog, select **Britta Simon** in the Users list.
247+
5. On **Users and groups** dialog, select **Britta Simon** in the Users list.
248+
249+
6. Click **Select** button on **Users and groups** dialog.
243250

244-
1. Click **Select** button on **Users and groups** dialog.
251+
7. Click **Assign** button on **Add Assignment** dialog.
245252

246-
1. Click **Assign** button on **Add Assignment** dialog.
247-
248253
### Test single sign-on
249254

250255
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
251256

252257
When you click the GitHub tile in the Access Panel, you should get automatically signed-on to your GitHub application.
253-
For more information about the Access Panel, see [Introduction to the Access Panel](../user-help/active-directory-saas-access-panel-introduction.md).
258+
For more information about the Access Panel, see [Introduction to the Access Panel](../user-help/active-directory-saas-access-panel-introduction.md).
254259

255260
## Additional resources
256261

257262
* [List of Tutorials on How to Integrate SaaS Apps with Azure Active Directory](tutorial-list.md)
258263
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
259264

260-
261-
262265
<!--Image references-->
263266

264267
[1]: ./media/github-tutorial/tutorial_general_01.png
@@ -271,5 +274,4 @@ For more information about the Access Panel, see [Introduction to the Access
271274
[200]: ./media/github-tutorial/tutorial_general_200.png
272275
[201]: ./media/github-tutorial/tutorial_general_201.png
273276
[202]: ./media/github-tutorial/tutorial_general_202.png
274-
[203]: ./media/github-tutorial/tutorial_general_203.png
275-
277+
[203]: ./media/github-tutorial/tutorial_general_203.png

0 commit comments

Comments
 (0)