Skip to content

Commit beaa098

Browse files
American-DipperAmerican-Dipper
authored
Merge pull request #93149 from v-viinde/opalupdate
Product Backlog Item 838364: SaaS App Tutorial: Opal Update
2 parents 02f9f71 + d251400 commit beaa098

File tree

1 file changed

+74
-133
lines changed

1 file changed

+74
-133
lines changed

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

Lines changed: 74 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Tutorial: Azure Active Directory integration with Opal | Microsoft Docs'
2+
title: 'Tutorial: Azure Active Directory single sign-on (SSO) integration with Opal | Microsoft Docs'
33
description: Learn how to configure single sign-on between Azure Active Directory and Opal.
44
services: active-directory
55
documentationCenter: na
@@ -14,92 +14,76 @@ ms.workload: identity
1414
ms.tgt_pltfrm: na
1515
ms.devlang: na
1616
ms.topic: tutorial
17-
ms.date: 03/14/2019
17+
ms.date: 10/24/2019
1818
ms.author: jeedes
1919

20+
ms.collection: M365-identity-device-management
2021
---
21-
# Tutorial: Azure Active Directory integration with Opal
2222

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

26-
* You can control in Azure AD who has access to Opal.
27-
* You can enable your users to be automatically signed-in to Opal (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 Opal with Azure Active Directory (Azure AD). When you integrate Opal 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 Opal.
28+
* Enable your users to be automatically signed-in to Opal 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 Opal, 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-
* Opal 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+
* Opal 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.
43-
44-
* Opal supports **IDP** initiated SSO
45-
46-
## Adding Opal from the gallery
47-
48-
To configure the integration of Opal into Azure AD, you need to add Opal from the gallery to your list of managed SaaS apps.
49-
50-
**To add Opal from the gallery, perform the following steps:**
51-
52-
1. In the **[Azure portal](https://portal.azure.com)**, on the left navigation panel, click **Azure Active Directory** icon.
53-
54-
![The Azure Active Directory button](common/select-azuread.png)
55-
56-
2. Navigate to **Enterprise Applications** and then select the **All Applications** option.
57-
58-
![The Enterprise applications blade](common/enterprise-applications.png)
42+
In this tutorial, you configure and test Azure AD SSO in a test environment.
5943

60-
3. To add new application, click **New application** button on the top of dialog.
6144

62-
![The New application button](common/add-new-app.png)
63-
64-
4. In the search box, type **Opal**, select **Opal** from result panel then click **Add** button to add the application.
65-
66-
![Opal in the results list](common/search-new-app.png)
45+
* Opal supports **IDP** initiated SSO
6746

68-
## Configure and test Azure AD single sign-on
47+
> [!NOTE]
48+
> Identifier of this application is a fixed string value so only one instance can be configured in one tenant.
6949
70-
In this section, you configure and test Azure AD single sign-on with Opal based on a test user called **Britta Simon**.
71-
For single sign-on to work, a link relationship between an Azure AD user and the related user in Opal needs to be established.
7250

73-
To configure and test Azure AD single sign-on with Opal, you need to complete the following building blocks:
51+
## Adding Opal from the gallery
7452

75-
1. **[Configure Azure AD Single Sign-On](#configure-azure-ad-single-sign-on)** - to enable your users to use this feature.
76-
2. **[Configure Opal Single Sign-On](#configure-opal-single-sign-on)** - to configure the Single Sign-On settings on application side.
77-
3. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
78-
4. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
79-
5. **[Create Opal test user](#create-opal-test-user)** - to have a counterpart of Britta Simon in Opal that is linked to the Azure AD representation of user.
80-
6. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
53+
To configure the integration of Opal into Azure AD, you need to add Opal from the gallery to your list of managed SaaS apps.
8154

82-
### Configure Azure AD single sign-on
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 **Opal** in the search box.
60+
1. Select **Opal** from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
8361

84-
In this section, you enable Azure AD single sign-on in the Azure portal.
8562

86-
To configure Azure AD single sign-on with Opal, perform the following steps:
63+
## Configure and test Azure AD single sign-on for Opal
8764

88-
1. In the [Azure portal](https://portal.azure.com/), on the **Opal** application integration page, select **Single sign-on**.
65+
Configure and test Azure AD SSO with Opal 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 Opal.
8966

90-
![Configure single sign-on link](common/select-sso.png)
67+
To configure and test Azure AD SSO with Opal, complete the following building blocks:
9168

92-
2. On the **Select a Single sign-on method** dialog, select **SAML/WS-Fed** mode to enable single sign-on.
69+
1. **[Configure Azure AD SSO](#configure-azure-ad-sso)** - to enable your users to use this feature.
70+
1. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with B.Simon.
71+
1. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable B.Simon to use Azure AD single sign-on.
72+
1. **[Configure Opal SSO](#configure-opal-sso)** - to configure the single sign-on settings on application side.
73+
1. **[Create Opal test user](#create-opal-test-user)** - to have a counterpart of B.Simon in Opal that is linked to the Azure AD representation of user.
74+
1. **[Test SSO](#test-sso)** - to verify whether the configuration works.
9375

94-
![Single sign-on select mode](common/select-saml-option.png)
76+
## Configure Azure AD SSO
9577

96-
3. On the **Set up Single Sign-On with SAML** page, click **Edit** icon to open **Basic SAML Configuration** dialog.
78+
Follow these steps to enable Azure AD SSO in the Azure portal.
9779

98-
![Edit Basic SAML Configuration](common/edit-urls.png)
80+
1. In the [Azure portal](https://portal.azure.com/), on the **Opal** application integration page, find the **Manage** section and select **single sign-on**.
81+
1. On the **Select a single sign-on method** page, select **SAML**.
82+
1. On the **Set up single sign-on with SAML** page, click the edit/pen icon for **Basic SAML Configuration** to edit the settings.
9983

100-
4. On the **Set up Single Sign-On with SAML** page, perform the following steps:
84+
![Edit Basic SAML Configuration](common/edit-urls.png)
10185

102-
![Opal Domain and URLs single sign-on information](common/idp-intiated.png)
86+
1. On the **Set up single sign-on with SAML** page, enter the values for the following fields:
10387

10488
a. In the **Identifier** text box, type a URL:
10589
`Opal`
@@ -110,119 +94,76 @@ To configure Azure AD single sign-on with Opal, perform the following steps:
11094
> [!NOTE]
11195
> The Reply URL value is not real. Update the value with the actual Reply URL. Contact [Opal Client support team](mailto:[email protected]) to get the value. You can also refer to the patterns shown in the **Basic SAML Configuration** section in the Azure portal.
11296

113-
5. Opal 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. Click **Edit** icon to open **User Attributes** dialog.
97+
1. Opal 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.
11498

11599
![image](common/edit-attribute.png)
116100

117-
6. In addition to above, Opal application expects few more attributes to be passed back in SAML response. In the **User Claims** section on the **User Attributes** dialog, perform the following steps to add SAML token attribute as shown in the below table:
101+
1. In addition to above, Opal application expects few more attributes to be passed back in SAML response which are shown below. These attributes are also pre populated but you can review them as per your requirement.
118102

119103
| Name | Source Attribute|
120104
| ---------------| --------------- |
121105
| firstname | user.givenname |
122106
| lastname | user.surname |
123107

124-
a. Click **Add new claim** to open the **Manage user claims** dialog.
125-
126-
![image](common/new-save-attribute.png)
127-
128-
![image](common/new-attribute-details.png)
129-
130-
b. In the **Name** textbox, type the attribute name shown for that row.
131-
132-
c. Leave the **Namespace** blank.
133-
134-
d. Select Source as **Attribute**.
135-
136-
e. From the **Source attribute** list, type the attribute value shown for that row.
137-
138-
f. Click **Ok**
139-
140-
g. Click **Save**.
141-
142-
7. 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.
108+
1. On the **Set up single sign-on with SAML** page, in the **SAML Signing Certificate** section, find **Federation Metadata XML** and select **Download** to download the certificate and save it on your computer.
143109

144110
![The Certificate download link](common/metadataxml.png)
145111

146-
8. On the **Set up Opal** section, copy the appropriate URL(s) as per your requirement.
112+
1. On the **Set up Opal** section, copy the appropriate URL(s) based on your requirement.
147113

148114
![Copy configuration URLs](common/copy-configuration-urls.png)
149115

150-
a. Login URL
151-
152-
b. Azure AD Identifier
153-
154-
c. Logout URL
155-
156-
### Configure Opal Single Sign-On
157-
158-
To configure single sign-on on **Opal** side, you need to send the downloaded **Federation Metadata XML** and appropriate copied URLs from Azure portal to [Opal support team](mailto:[email protected]). They set this setting to have the SAML SSO connection set properly on both sides.
159-
160-
### Create an Azure AD test user
161-
162-
The objective of this section is to create a test user in the Azure portal called Britta Simon.
163-
164-
1. In the Azure portal, in the left pane, select **Azure Active Directory**, select **Users**, and then select **All users**.
165-
166-
![The "Users and groups" and "All users" links](common/users.png)
116+
### Create an Azure AD test user
167117

168-
2. Select **New user** at the top of the screen.
118+
In this section, you'll create a test user in the Azure portal called B.Simon.
169119

170-
![New user Button](common/new-user.png)
171-
172-
3. In the User properties, perform the following steps.
173-
174-
![The User dialog box](common/user-properties.png)
175-
176-
a. In the **Name** field enter **BrittaSimon**.
177-
178-
b. In the **User name** field type **[email protected]**
179-
For example, [email protected]
180-
181-
c. Select **Show password** check box, and then write down the value that's displayed in the Password box.
182-
183-
d. Click **Create**.
120+
1. From the left pane in the Azure portal, select **Azure Active Directory**, select **Users**, and then select **All users**.
121+
1. Select **New user** at the top of the screen.
122+
1. In the **User** properties, follow these steps:
123+
1. In the **Name** field, enter `B.Simon`.
124+
1. In the **User name** field, enter the [email protected]. For example, `[email protected]`.
125+
1. Select the **Show password** check box, and then write down the value that's displayed in the **Password** box.
126+
1. Click **Create**.
184127

185128
### Assign the Azure AD test user
186129

187-
In this section, you enable Britta Simon to use Azure single sign-on by granting access to Opal.
188-
189-
1. In the Azure portal, select **Enterprise Applications**, select **All applications**, then select **Opal**.
130+
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to Opal.
190131

191-
![Enterprise applications blade](common/enterprise-applications.png)
132+
1. In the Azure portal, select **Enterprise Applications**, and then select **All applications**.
133+
1. In the applications list, select **Opal**.
134+
1. In the app's overview page, find the **Manage** section and select **Users and groups**.
192135

193-
2. In the applications list, select **Opal**.
136+
![The "Users and groups" link](common/users-groups-blade.png)
194137

195-
![The Opal link in the Applications list](common/all-applications.png)
138+
1. Select **Add user**, then select **Users and groups** in the **Add Assignment** dialog.
196139

197-
3. In the menu on the left, select **Users and groups**.
140+
![The Add User link](common/add-assign-user.png)
198141

199-
![The "Users and groups" link](common/users-groups-blade.png)
142+
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.
143+
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.
144+
1. In the **Add Assignment** dialog, click the **Assign** button.
200145

201-
4. Click the **Add user** button, then select **Users and groups** in the **Add Assignment** dialog.
146+
## Configure Opal SSO
202147

203-
![The Add Assignment pane](common/add-assign-user.png)
204-
205-
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.
206-
207-
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.
208-
209-
7. In the **Add Assignment** dialog click the **Assign** button.
148+
To configure single sign-on on **Opal** side, you need to send the downloaded **Federation Metadata XML** and appropriate copied URLs from Azure portal to [Opal support team](mailto:[email protected]). They set this setting to have the SAML SSO connection set properly on both sides.
210149

211150
### Create Opal test user
212151

213-
In this section, you create a user called Britta Simon in Opal. Work with [Opal support team](mailto:[email protected]) to add the users in the Opal platform. Users must be created and activated before you use single sign-on.
152+
In this section, you create a user called Britta Simon in Opal. Work with [Opal support team](mailto:[email protected]) to add the users in the Opal platform. Users must be created and activated before you use single sign-on.
214153

215-
### Test single sign-on
154+
## Test SSO
216155

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

219158
When you click the Opal tile in the Access Panel, you should be automatically signed in to the Opal 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).
220159

221-
## Additional Resources
160+
## Additional resources
161+
162+
- [ 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)
222163

223-
- [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)
164+
- [What is application access and single sign-on with Azure Active Directory? ](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
224165

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

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

0 commit comments

Comments
 (0)