Skip to content

Commit fd9afa0

Browse files
authored
Merge pull request #31007 from prabjeetsinghmitel/Prabjeet-Mitel-MSFT-patch-1
Updated tutorial for Mitel SSO enterprise app
2 parents 91a8847 + ec49325 commit fd9afa0

File tree

6 files changed

+96
-71
lines changed

6 files changed

+96
-71
lines changed
51.2 KB
Loading
176 KB
Loading
48.3 KB
Loading
21.5 KB
Loading
25.8 KB
Loading

articles/active-directory/saas-apps/mitel-connect-tutorial.md

Lines changed: 96 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -17,180 +17,205 @@ ms.date: 05/03/2019
1717
ms.author: jeedes
1818

1919
---
20-
# Tutorial: Azure Active Directory integration with Mitel Connect
20+
# Tutorial: Azure Active Directory integration with Mitel MiCloud Connect
2121

22-
In this tutorial, you learn how to integrate Mitel Connect with Azure Active Directory (Azure AD).
23-
Integrating Mitel Connect with Azure AD provides you with the following benefits:
22+
In this tutorial, you will learn how to integrate Mitel MiCloud Connect with Azure Active Directory (Azure AD). Integrating MiCloud Connect with Azure AD provides you with the following benefits:
23+
24+
* You can control in Azure AD who has access to MiCloud Connect apps using their enterprise credentials.
25+
* You can enable users on your account to be automatically signed-in to MiCloud Connect (Single Sign-On) with their Azure AD accounts.
2426

25-
* You can control in Azure AD who has access to Mitel Connect.
26-
* You can enable your users to be automatically signed-in to Mitel Connect (Single Sign-On) with their Azure AD accounts.
27-
* You can manage your accounts in one central location - the Azure portal.
2827

2928
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).
3029
If you don't have an Azure subscription, [create a free account](https://azure.microsoft.com/free/) before you begin.
3130

3231
## Prerequisites
3332

34-
To configure Azure AD integration with Mitel Connect, you need the following items:
33+
To configure Azure AD integration with MiCloud Connect, you need the following items:
34+
35+
* An Azure AD subscription
3536

36-
* An Azure AD subscription. If you don't have an Azure AD environment, you can get a [free account](https://azure.microsoft.com/free/)
37-
* Mitel Connect single sign-on enabled subscription
37+
If you don't have an Azure AD environment, you can get a [free account](https://azure.microsoft.com/free/).
38+
* A Mitel MiCloud Connect account
3839

3940
## Scenario description
4041

41-
In this tutorial, you configure and test Azure AD single sign-on in a test environment.
42+
In this tutorial, you will configure and test Azure AD single sign-on (SSO).
4243

4344
* Mitel Connect supports **SP** initiated SSO
4445

4546
## Adding Mitel Connect from the gallery
4647

47-
To configure the integration of Mitel Connect into Azure AD, you need to add Mitel Connect from the gallery to your list of managed SaaS apps.
48+
To configure the integration of Mitel Connect into Azure AD, you need to add Mitel Connect from the gallery to your list of managed SaaS apps in the Azure portal.
4849

4950
**To add Mitel Connect from the gallery, perform the following steps:**
5051

51-
1. In the **[Azure portal](https://portal.azure.com)**, on the left navigation panel, click **Azure Active Directory** icon.
52+
1. In the **[Azure portal](https://portal.azure.com)**, on the left navigation panel, click **Azure Active Directory**.
5253

5354
![The Azure Active Directory button](common/select-azuread.png)
5455

55-
2. Navigate to **Enterprise Applications** and then select the **All Applications** option.
56+
2. Click **Enterprise Applications** and then click **All Applications**.
5657

5758
![The Enterprise applications blade](common/enterprise-applications.png)
5859

59-
3. To add new application, click **New application** button on the top of dialog.
60+
3. Click **New application**.
6061

6162
![The New application button](common/add-new-app.png)
6263

63-
4. In the search box, type **Mitel Connect**, select **Mitel Connect** from result panel then click **Add** button to add the application.
64+
4. Type **Mitel Connect** in the search field, click **Mitel Connect** from results panel, and then click **Add**.
6465

6566
![Mitel Connect in the results list](common/search-new-app.png)
6667

6768
## Configure and test Azure AD single sign-on
6869

69-
In this section, you configure and test Azure AD single sign-on with Mitel Connect based on a test user called **Britta Simon**.
70-
For single sign-on to work, a link relationship between an Azure AD user and the related user in Mitel Connect needs to be established.
70+
In this section, you will configure and test Azure AD single sign-on with MiCloud Connect based on a test user named **Britta Simon**. For single sign-on to work, a link relationship between an Azure AD user and the related user in MiCloud Connect needs to be established.
71+
72+
To configure and test Azure AD single sign-on with MiCloud Connect, you need to complete the following steps:
7173

72-
To configure and test Azure AD single sign-on with Mitel Connect, you need to complete the following building blocks:
74+
1. **[Configure MiCloud Connect for SSO with Azure AD](#configure-micloud-connect-for-sso-with-azure-ad)** - to enable your users to use this feature and to configure the SSO settings on the application side.
75+
2. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
76+
3. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
77+
4. **[Create a Mitel MiCloud Connect test user](#create-mitel-micloud-connect-test-user)** - to have a counterpart of Britta Simon on your MiCloud Connect account that is linked to the Azure AD representation of the user.
78+
5. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
7379

74-
1. **[Configure Azure AD Single Sign-On](#configure-azure-ad-single-sign-on)** - to enable your users to use this feature.
75-
2. **[Configure Mitel Connect Single Sign-On](#configure-mitel-connect-single-sign-on)** - to configure the Single Sign-On settings on application side.
76-
3. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
77-
4. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
78-
5. **[Create Mitel Connect test user](#create-mitel-connect-test-user)** - to have a counterpart of Britta Simon in Mitel Connect that is linked to the Azure AD representation of user.
79-
6. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
80+
### Configure MiCloud Connect for SSO with Azure AD
8081

81-
### Configure Azure AD single sign-on
82+
In this section, you will enable Azure AD single sign-on for MiCloud Connect in the Azure portal and configure your MiCloud Connect account to allow SSO using Azure AD.
8283

83-
In this section, you enable Azure AD single sign-on in the Azure portal.
84+
To configure MiCloud Connect with SSO for Azure AD, it is easiest to open the Azure portal and the Mitel Account portal side-by-side. You will need to copy some information from the Azure portal to the Mitel Account portal and some from the Mitel Account portal to the Azure portal.
8485

85-
To configure Azure AD single sign-on with Mitel Connect, perform the following steps:
8686

87-
1. In the [Azure portal](https://portal.azure.com/), on the **Mitel Connect** application integration page, select **Single sign-on**.
87+
1. To open the configuration page in the [Azure portal](https://portal.azure.com/), do the following:
88+
89+
a. On the **Mitel Connect** application integration page, click **Single sign-on**.
8890

8991
![Configure single sign-on link](common/select-sso.png)
9092

91-
2. On the **Select a Single sign-on method** dialog, select **SAML/WS-Fed** mode to enable single sign-on.
93+
b. In the **Select a Single sign-on method** dialog, click **SAML**.
9294

9395
![Single sign-on select mode](common/select-saml-option.png)
96+
97+
The SAML-based sign-on page is displayed.
98+
99+
2. To open the configuration dialog in the Mitel Account portal, do the following:
94100

95-
3. On the **Set up Single Sign-On with SAML** page, click **Edit** icon to open **Basic SAML Configuration** dialog.
101+
a. On the **Phone System** menu, click **Add-On Features**.
96102

97-
![Edit Basic SAML Configuration](common/edit-urls.png)
103+
b. To the right of **Single Sign-On**, click **Activate** or **Settings**.
104+
105+
The Connect Single Sign-On Settings dialog box appears.
106+
107+
3. Select the **Enable Single Sign-On** check box.
108+
![image](./media/mitel-connect-tutorial/Mitel_Connect_Enable.png)
98109

99-
4. On the **Basic SAML Configuration** section, perform the following steps:
100110

101-
![Mitel Connect Domain and URLs single sign-on information](common/sp-identifier.png)
111+
4. In the Azure portal, click the **Edit** icon in the **Basic SAML Configuration** section.
112+
![image](common/edit-urls.png)
102113

103-
a. In the **Sign on URL** text box, type a URL:
114+
The Basic SAML Configuration dialog box appears.
104115

105-
| |
106-
|--|
107-
| `https://portal.shoretelsky.com`|
108-
| `https://teamwork.shoretel.com`|
109-
| |
116+
5. Copy the URL from the **Mitel Identifier (Entity ID)** field in the Mitel Account portal and paste it into the **Identifier (Entity ID)** field in the Azure portal.
110117

111-
b. In the **Identifier (Entity ID)** text box, type a URL using the following pattern:
112-
`https://authentication.api.mitel.io/2017-09-01/saml2/<account-uui>`
118+
6. Copy the URL from the **Reply URL (Assertion Consumer Service URL)** field in the Mitel Account portal and paste it into the **Reply URL (Assertion Consumer Service URL)** field in the Azure portal.
119+
![image](./media/mitel-connect-tutorial/Mitel_Azure_BasicConfig.png)
113120

114-
> [!NOTE]
115-
> The Identifier value is not real. Update this value with the actual Identifier. Contact [Mitel Connect Client support team](https://www.mitel.com/support/mitel-technical-support) to get this value. You can also refer to the patterns shown in the **Basic SAML Configuration** section in the Azure portal.
121+
7. In the **Sign on URL** text box, type one of the following URLs:
116122

117-
5. On the **Set up Single Sign-On with SAML** page, in the **SAML Signing Certificate** section, click **Download** to download the **Federation Metadata XML** from the given options as per your requirement and save it on your computer.
123+
* **https://portal.shoretelsky.com** - to use the Mitel Account portal as your default Mitel application
124+
* **https://teamwork.shoretel.com** - to use Teamwork as your default Mitel application
118125

119-
![The Certificate download link](common/metadataxml.png)
126+
**NOTE**: The default Mitel application is the application accessed when a user clicks on the Mitel Connect tile in the Access Panel. This is also the application accessed when performing a test setup from Azure AD.
120127

121-
6. On the **Set up Mitel Connect** section, copy the appropriate URL(s) as per your requirement.
128+
8. Click **Save** in the **Basic SAML Configuration** dialog box in the Azure portal.
122129

123-
![Copy configuration URLs](common/copy-configuration-urls.png)
130+
9. In the **SAML Signing Certificate** section on the **SAML-based sign-on** page in the Azure portal, click **Download** next to **Certificate (Base64)** to download the **Signing Certificate** and save it to your computer.
131+
![image](./media/mitel-connect-tutorial/Azure_SigningCert.png)
124132

125-
a. Login URL
133+
10. Open the Signing Certificate file in a text editor, copy all data in the file, and then paste the data in the **Signing Certificate** field in the Mitel Account portal.
134+
![image](./media/mitel-connect-tutorial/Mitel_Connect_SigningCert.png)
126135

127-
b. Azure AD Identifier
136+
11. In the **Set up Mitel Connect** section on the **SAML-based sign-on** page of the Azure portal, do the following:
128137

129-
c. Logout URL
138+
a. Copy the URL from the **Login URL** field and paste it into the **Sign-in URL** field in the Mitel Account portal.
130139

131-
### Configure Mitel Connect Single Sign-On
140+
b. Copy the URL from the **Azure AD Identifier** field and paste it into the **Entity ID** field in the Mitel Account portal.
141+
![image](./media/mitel-connect-tutorial/Mitel_Azure_SetupConnect.png)
132142

133-
To configure single sign-on on **Mitel Connect** side, you need to send the downloaded **Federation Metadata XML** and appropriate copied URLs from Azure portal to [Mitel Connect support team](https://www.mitel.com/support/mitel-technical-support). They set this setting to have the SAML SSO connection set properly on both sides.
143+
12. Click **Save** on the **Connect Single Sign-On Settings** dialog box in the Mitel Account portal.
134144

135145
### Create an Azure AD test user
136146

137-
The objective of this section is to create a test user in the Azure portal called Britta Simon.
147+
In this section, you will create a test user named Britta Simon in the Azure portal.
138148

139-
1. In the Azure portal, in the left pane, select **Azure Active Directory**, select **Users**, and then select **All users**.
149+
1. In the Azure portal, in the left pane, click **Azure Active Directory**, click **Users**, and then click **All users**.
140150

141151
![The "Users and groups" and "All users" links](common/users.png)
142152

143-
2. Select **New user** at the top of the screen.
153+
2. Click **New user** at the top of the screen.
144154

145155
![New user Button](common/new-user.png)
146156

147-
3. In the User properties, perform the following steps.
157+
3. In the User properties dialog, perform the following steps:
148158

149159
![The User dialog box](common/user-properties.png)
150160

151-
a. In the **Name** field, enter **BrittaSimon**.
161+
a. In the **Name** field, type **BrittaSimon**.
152162

153-
b. In the **User name** field, type [email protected]. For example, [email protected].
163+
b. In the **User name** field, type brittasimon@\<yourcompanydomain\>.\<extension\>.
164+
For example, [email protected].
154165

155-
c. Select **Show password** check box, and then write down the value that's displayed in the Password box.
166+
c. Select the **Show password** check box, and then write down the value that is displayed in the **Password** box.
156167

157168
d. Click **Create**.
158169

159170
### Assign the Azure AD test user
160171

161-
In this section, you enable Britta Simon to use Azure single sign-on by granting access to Mitel Connect.
172+
In this section, you will enable Britta Simon to use Azure single sign-on by granting access to Mitel Connect.
162173

163-
1. In the Azure portal, select **Enterprise Applications**, select **All applications**, then select **Mitel Connect**.
174+
1. In the Azure portal, click **Enterprise Applications**, and then click **All applications**.
164175

165176
![Enterprise applications blade](common/enterprise-applications.png)
166177

167-
2. In the applications list, select **Mitel Connect**.
178+
2. In the applications list, click **Mitel Connect**.
168179

169180
![The Mitel Connect link in the Applications list](common/all-applications.png)
170181

171-
3. In the menu on the left, select **Users and groups**.
182+
3. In the menu on the left, click **Users and groups**.
172183

173184
![The "Users and groups" link](common/users-groups-blade.png)
174185

175-
4. Click the **Add user** button, then select **Users and groups** in the **Add Assignment** dialog.
186+
4. Click **Add user**, then click **Users and groups** in the **Add Assignment** dialog.
176187

177188
![The Add Assignment pane](common/add-assign-user.png)
178189

179-
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.
190+
5. In the **Users and groups** dialog, select **Britta Simon** in the **Users** list, then click **Select** at the bottom of the screen.
191+
192+
6. If you are expecting any role value in the SAML assertion, select the appropriate role for the user from the list in the **Select Role** dialog, and then click **Select** at the bottom of the screen.
193+
194+
7. In the **Add Assignment** dialog, click **Assign**.
195+
196+
### Create a Mitel MiCloud Connect test user
197+
198+
In this section, you create a user named Britta Simon on your MiCloud Connect account. Users must be created and activated before using single sign-on.
199+
200+
For details about adding users in the Mitel Account portal, see the [Adding a User](docs.shoretel.com/connectcloud/Account/Users/AddUser) article in the Mitel Knowledge Base.
201+
202+
Create a user on your MiCloud Connect account with the following details:
180203

181-
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.
204+
* **Name:** Britta Simon
182205

183-
7. In the **Add Assignment** dialog, click the **Assign** button.
206+
* **Business Email Address:** `brittasimon@<yourcompanydomain>.<extension>`
207+
184208

185-
### Create Mitel Connect test user
209+
* **Username:** `brittasimon@<yourcompanydomain>.<extension> `
210+
(Example: [[email protected]](mailto:[email protected]); the user’s username is typically the same as the user’s business email address)
186211

187-
In this section, you create a user called Britta Simon in Mitel Connect. Work with [Mitel Connect support team](https://www.mitel.com/support/mitel-technical-support) to add the users in the Mitel Connect platform. Users must be created and activated before you use single sign-on.
212+
**NOTE:** The user’s MiCloud Connect username must be identical to the user’s email address in Azure.
188213

189214
### Test single sign-on
190215

191-
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
216+
In this section, you will test your Azure AD single sign-on configuration using the Access Panel.
192217

193-
When you click the Mitel Connect tile in the Access Panel, you should be automatically signed in to the Mitel Connect 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).
218+
When you click the Mitel Connect tile in the Access Panel, you should be automatically redirected to sign in to the MiCloud Connect application you configured as your default in the **Sign on URL** field. 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).
194219

195220
## Additional Resources
196221

0 commit comments

Comments
 (0)