Skip to content

Commit 83d13c4

Browse files
GitHubber17GitHubber17
authored
Merge pull request #86780 from v-viinde/envoyoneclickupdate
Product Backlog Item 800362: SaaS App Tutorial: Envoy One Click Update
2 parents 76a0cd3 + a83f91a commit 83d13c4

File tree

1 file changed

+87
-123
lines changed

1 file changed

+87
-123
lines changed

‎articles/active-directory/saas-apps/envoy-tutorial.md

Lines changed: 87 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Tutorial: Azure Active Directory integration with Envoy | Microsoft Docs'
2+
title: 'Tutorial: Azure Active Directory single sign-on (SSO) integration with Envoy | Microsoft Docs'
33
description: Learn how to configure single sign-on between Azure Active Directory and Envoy.
44
services: active-directory
55
documentationCenter: na
@@ -9,141 +9,154 @@ ms.reviewer: barbkess
99

1010
ms.assetid: 71f7afcc-1033-4098-9b7e-4f9f2b26f734
1111
ms.service: active-directory
12+
ms.subservice: saas-app-tutorial
1213
ms.workload: identity
1314
ms.tgt_pltfrm: na
1415
ms.devlang: na
1516
ms.topic: tutorial
16-
ms.date: 02/06/2019
17+
ms.date: 08/29/2019
1718
ms.author: jeedes
1819

1920
ms.collection: M365-identity-device-management
2021
---
21-
# Tutorial: Azure Active Directory integration with Envoy
2222

23-
In this tutorial, you learn how to integrate Envoy with Azure Active Directory (Azure AD).
24-
Integrating Envoy with Azure AD provides you with the following benefits:
23+
# Tutorial: Azure Active Directory single sign-on (SSO) integration with Envoy
2524

26-
* You can control in Azure AD who has access to Envoy.
27-
* You can enable your users to be automatically signed-in to Envoy (Single Sign-On) with their Azure AD accounts.
28-
* You can manage your accounts in one central location - the Azure portal.
25+
In this tutorial, you'll learn how to integrate Envoy with Azure Active Directory (Azure AD). When you integrate Envoy with Azure AD, you can:
2926

30-
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](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis).
31-
If you don't have an Azure subscription, [create a free account](https://azure.microsoft.com/free/) before you begin.
27+
* Control in Azure AD who has access to Envoy.
28+
* Enable your users to be automatically signed-in to Envoy with their Azure AD accounts.
29+
* Manage your accounts in one central location - the Azure portal.
30+
31+
To learn more about SaaS app integration with Azure AD, see [What is application access and single sign-on with Azure Active Directory](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis).
3232

3333
## Prerequisites
3434

35-
To configure Azure AD integration with Envoy, you need the following items:
35+
To get started, you need the following items:
3636

37-
* An Azure AD subscription. If you don't have an Azure AD environment, you can get one-month trial [here](https://azure.microsoft.com/pricing/free-trial/)
38-
* Envoy single sign-on enabled subscription
37+
* An Azure AD subscription. If you don't have a subscription, you can get a [free account](https://azure.microsoft.com/free/).
38+
* Envoy single sign-on (SSO) enabled subscription.
3939

4040
## Scenario description
4141

42-
In this tutorial, you configure and test Azure AD single sign-on in a test environment.
42+
In this tutorial, you configure and test Azure AD SSO in a test environment.
4343

4444
* Envoy supports **SP** initiated SSO
4545

4646
* Envoy supports **Just In Time** user provisioning
4747

48+
> [!NOTE]
49+
> Identifier of this application is a fixed string value so only one instance can be configured in one tenant.
50+
4851
## Adding Envoy from the gallery
4952

5053
To configure the integration of Envoy into Azure AD, you need to add Envoy from the gallery to your list of managed SaaS apps.
5154

52-
**To add Envoy from the gallery, perform the following steps:**
53-
54-
1. In the **[Azure portal](https://portal.azure.com)**, on the left navigation panel, click **Azure Active Directory** icon.
55+
1. Sign in to the [Azure portal](https://portal.azure.com) using either a work or school account, or a personal Microsoft account.
56+
1. On the left navigation pane, select the **Azure Active Directory** service.
57+
1. Navigate to **Enterprise Applications** and then select **All Applications**.
58+
1. To add new application, select **New application**.
59+
1. In the **Add from the gallery** section, type **Envoy** in the search box.
60+
1. Select **Envoy** from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
5561

56-
![The Azure Active Directory button](common/select-azuread.png)
62+
## Configure and test Azure AD single sign-on for Envoy
5763

58-
2. Navigate to **Enterprise Applications** and then select the **All Applications** option.
64+
Configure and test Azure AD SSO with Envoy 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 Envoy.
5965

60-
![The Enterprise applications blade](common/enterprise-applications.png)
66+
To configure and test Azure AD SSO with Envoy, complete the following building blocks:
6167

62-
3. To add new application, click **New application** button on the top of dialog.
68+
1. **[Configure Azure AD SSO](#configure-azure-ad-sso)** - to enable your users to use this feature.
69+
1. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with B.Simon.
70+
1. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable B.Simon to use Azure AD single sign-on.
71+
1. **[Configure Envoy SSO](#configure-envoy-sso)** - to configure the single sign-on settings on application side.
72+
1. **[Create Envoy test user](#create-envoy-test-user)** - to have a counterpart of B.Simon in Envoy that is linked to the Azure AD representation of user.
73+
1. **[Test SSO](#test-sso)** - to verify whether the configuration works.
6374

64-
![The New application button](common/add-new-app.png)
75+
## Configure Azure AD SSO
6576

66-
4. In the search box, type **Envoy**, select **Envoy** from result panel then click **Add** button to add the application.
77+
Follow these steps to enable Azure AD SSO in the Azure portal.
6778

68-
![Envoy in the results list](common/search-new-app.png)
79+
1. In the [Azure portal](https://portal.azure.com/), on the **Envoy** application integration page, find the **Manage** section and select **single sign-on**.
80+
1. On the **Select a single sign-on method** page, select **SAML**.
81+
1. On the **Set up single sign-on with SAML** page, click the edit/pen icon for **Basic SAML Configuration** to edit the settings.
6982

70-
## Configure and test Azure AD single sign-on
83+
![Edit Basic SAML Configuration](common/edit-urls.png)
7184

72-
In this section, you configure and test Azure AD single sign-on with Envoy based on a test user called **Britta Simon**.
73-
For single sign-on to work, a link relationship between an Azure AD user and the related user in Envoy needs to be established.
85+
1. On the **Basic SAML Configuration** section, enter the values for the following fields:
7486

75-
To configure and test Azure AD single sign-on with Envoy, you need to complete the following building blocks:
76-
77-
1. **[Configure Azure AD Single Sign-On](#configure-azure-ad-single-sign-on)** - to enable your users to use this feature.
78-
2. **[Configure Envoy Single Sign-On](#configure-envoy-single-sign-on)** - to configure the Single Sign-On settings on application side.
79-
3. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
80-
4. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
81-
5. **[Create Envoy test user](#create-envoy-test-user)** - to have a counterpart of Britta Simon in Envoy that is linked to the Azure AD representation of user.
82-
6. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
83-
84-
### Configure Azure AD single sign-on
87+
In the **Sign-on URL** text box, type a URL using the following pattern:
88+
`https://app.envoy.com/a/saml/auth/<company-ID-from-Envoy>`
8589

86-
In this section, you enable Azure AD single sign-on in the Azure portal.
90+
> [!NOTE]
91+
> The value is not real. Update the value with the actual Sign-On URL. Contact [Envoy Client support team](https://envoy.com/contact/) to get the value. You can also refer to the patterns shown in the **Basic SAML Configuration** section in the Azure portal.
8792

88-
To configure Azure AD single sign-on with Envoy, perform the following steps:
93+
1. In the **SAML Signing Certificate** section, click **Edit** button to open **SAML Signing Certificate** dialog.
8994

90-
1. In the [Azure portal](https://portal.azure.com/), on the **Envoy** application integration page, select **Single sign-on**.
95+
![Edit SAML Signing Certificate](common/edit-certificate.png)
9196

92-
![Configure single sign-on link](common/select-sso.png)
97+
1. In the **SAML Signing Certificate** section, copy the **Thumbprint Value** and save it on your computer.
9398

94-
2. On the **Select a Single sign-on method** dialog, select **SAML/WS-Fed** mode to enable single sign-on.
99+
![Copy Thumbprint value](common/copy-thumbprint.png)
95100

96-
![Single sign-on select mode](common/select-saml-option.png)
101+
1. On the **Set up Envoy** section, copy the appropriate URL(s) based on your requirement.
97102

98-
3. On the **Set up Single Sign-On with SAML** page, click **Edit** icon to open **Basic SAML Configuration** dialog.
103+
![Copy configuration URLs](common/copy-configuration-urls.png)
99104

100-
![Edit Basic SAML Configuration](common/edit-urls.png)
105+
### Create an Azure AD test user
101106

102-
4. On the **Basic SAML Configuration** section, perform the following steps:
107+
In this section, you'll create a test user in the Azure portal called B.Simon.
103108

104-
![Envoy Domain and URLs single sign-on information](common/sp-signonurl.png)
109+
1. From the left pane in the Azure portal, select **Azure Active Directory**, select **Users**, and then select **All users**.
110+
1. Select **New user** at the top of the screen.
111+
1. In the **User** properties, follow these steps:
112+
1. In the **Name** field, enter `B.Simon`.
113+
1. In the **User name** field, enter the [email protected]. For example, `[email protected]`.
114+
1. Select the **Show password** check box, and then write down the value that's displayed in the **Password** box.
115+
1. Click **Create**.
105116

106-
In the **Sign-on URL** text box, type a URL using the following pattern:
107-
`https://app.envoy.com/a/saml/auth/<company-ID-from-Envoy>`
117+
### Assign the Azure AD test user
108118

109-
> [!NOTE]
110-
> The value is not real. Update the value with the actual Sign-On URL. Contact [Envoy Client support team](https://envoy.com/contact/) to get the value. You can also refer to the patterns shown in the **Basic SAML Configuration** section in the Azure portal.
119+
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to Envoy.
111120

112-
5. In the **SAML Signing Certificate** section, click **Edit** button to open **SAML Signing Certificate** dialog.
121+
1. In the Azure portal, select **Enterprise Applications**, and then select **All applications**.
122+
1. In the applications list, select **Envoy**.
123+
1. In the app's overview page, find the **Manage** section and select **Users and groups**.
113124

114-
![Edit SAML Signing Certificate](common/edit-certificate.png)
125+
![The "Users and groups" link](common/users-groups-blade.png)
115126

116-
6. In the **SAML Signing Certificate** section, copy the **Thumbprint** and save it on your computer.
127+
1. Select **Add user**, then select **Users and groups** in the **Add Assignment** dialog.
117128

118-
![Copy Thumbprint value](common/copy-thumbprint.png)
129+
![The Add User link](common/add-assign-user.png)
119130

120-
7. On the **Set up Envoy** section, copy the appropriate URL(s) as per your requirement.
131+
1. In the **Users and groups** dialog, select **B.Simon** from the Users list, then click the **Select** button at the bottom of the screen.
132+
1. If you're expecting any role value in the SAML assertion, in the **Select Role** dialog, select the appropriate role for the user from the list and then click the **Select** button at the bottom of the screen.
133+
1. In the **Add Assignment** dialog, click the **Assign** button.
121134

122-
![Copy configuration URLs](common/copy-configuration-urls.png)
135+
## Configure Envoy SSO
123136

124-
a. Login URL
137+
1. To automate the configuration within Envoy, you need to install **My Apps Secure Sign-in browser extension** by clicking **Install the extension**.
125138

126-
b. Azure Ad Identifier
139+
![My apps extension](common/install-myappssecure-extension.png)
127140

128-
c. Logout URL
141+
2. After adding extension to the browser, click on **Setup Envoy** will direct you to the Envoy application. From there, provide the admin credentials to sign into Envoy. The browser extension will automatically configure the application for you and automate steps 3-7.
129142

130-
### Configure Envoy Single Sign-On
143+
![Setup configuration](common/setup-sso.png)
131144

132-
1. In a different web browser window, log into your Envoy company site as an administrator.
145+
3. If you want to setup Envoy manually, open a new web browser window and sign into your Envoy company site as an administrator and perform the following steps:
133146

134-
2. In the toolbar on the top, click **Settings**.
147+
4. In the toolbar on the top, click **Settings**.
135148

136149
![Envoy](./media/envoy-tutorial/ic776782.png "Envoy")
137150

138-
3. Click **Company**.
151+
5. Click **Company**.
139152

140153
![Company](./media/envoy-tutorial/ic776783.png "Company")
141154

142-
4. Click **SAML**.
155+
6. Click **SAML**.
143156

144157
![SAML](./media/envoy-tutorial/ic776784.png "SAML")
145158

146-
5. In the **SAML Authentication** configuration section, perform the following steps:
159+
7. In the **SAML Authentication** configuration section, perform the following steps:
147160

148161
![SAML authentication](./media/envoy-tutorial/ic776785.png "SAML authentication")
149162

@@ -156,72 +169,23 @@ To configure Azure AD single sign-on with Envoy, perform the following steps:
156169

157170
c. Click **Save changes**.
158171

159-
### Create an Azure AD test user
160-
161-
The objective of this section is to create a test user in the Azure portal called Britta Simon.
162-
163-
1. In the Azure portal, in the left pane, select **Azure Active Directory**, select **Users**, and then select **All users**.
164-
165-
![The "Users and groups" and "All users" links](common/users.png)
166-
167-
2. Select **New user** at the top of the screen.
168-
169-
![New user Button](common/new-user.png)
170-
171-
3. In the User properties, perform the following steps.
172-
173-
![The User dialog box](common/user-properties.png)
174-
175-
a. In the **Name** field enter **BrittaSimon**.
176-
177-
b. In the **User name** field type **brittasimon\@yourcompanydomain.extension**
178-
For example, [email protected]
179-
180-
c. Select **Show password** check box, and then write down the value that's displayed in the Password box.
181-
182-
d. Click **Create**.
183-
184-
### Assign the Azure AD test user
185-
186-
In this section, you enable Britta Simon to use Azure single sign-on by granting access to Envoy.
187-
188-
1. In the Azure portal, select **Enterprise Applications**, select **All applications**, then select **Envoy**.
189-
190-
![Enterprise applications blade](common/enterprise-applications.png)
191-
192-
2. In the applications list, select **Envoy**.
193-
194-
![The Envoy link in the Applications list](common/all-applications.png)
195-
196-
3. In the menu on the left, select **Users and groups**.
197-
198-
![The "Users and groups" link](common/users-groups-blade.png)
199-
200-
4. Click the **Add user** button, then select **Users and groups** in the **Add Assignment** dialog.
201-
202-
![The Add Assignment pane](common/add-assign-user.png)
203-
204-
5. In the **Users and groups** dialog select **Britta Simon** in the Users list, then click the **Select** button at the bottom of the screen.
205-
206-
6. If you are expecting any role value in the SAML assertion then in the **Select Role** dialog select the appropriate role for the user from the list, then click the **Select** button at the bottom of the screen.
207-
208-
7. In the **Add Assignment** dialog click the **Assign** button.
209-
210172
### Create Envoy test user
211173

212-
There is no action item for you to configure user provisioning to Envoy. When an assigned user tries to log into Envoy using the access panel, Envoy checks whether the user exists. If there is no user account available yet, it is automatically created by Envoy.
174+
In this section, a user called Britta Simon is created in Envoy. Envoy supports just-in-time user provisioning, which is enabled by default. There is no action item for you in this section. If a user doesn't already exist in Envoy, a new one is created after authentication.
213175

214-
### Test single sign-on
176+
## Test SSO
215177

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

218180
When you click the Envoy tile in the Access Panel, you should be automatically signed in to the Envoy for which you set up SSO. For more information about the Access Panel, see [Introduction to the Access Panel](https://docs.microsoft.com/azure/active-directory/active-directory-saas-access-panel-introduction).
219181

220-
## Additional Resources
182+
## Additional resources
183+
184+
- [ List of Tutorials on How to Integrate SaaS Apps with Azure Active Directory ](https://docs.microsoft.com/azure/active-directory/active-directory-saas-tutorial-list)
221185

222-
- [List of Tutorials on How to Integrate SaaS Apps with Azure Active Directory](https://docs.microsoft.com/azure/active-directory/active-directory-saas-tutorial-list)
186+
- [What is application access and single sign-on with Azure Active Directory? ](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
223187

224-
- [What is application access and single sign-on with Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
188+
- [What is conditional access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)
225189

226-
- [What is Conditional Access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)
190+
- [Try Envoy with Azure AD](https://aad.portal.azure.com/)
227191

0 commit comments

Comments
 (0)