Skip to content

Commit 5af8b9e

Browse files
GitHubber17GitHubber17
authored
Merge pull request #99903 from v-nagta/apexportalupdate
Product Backlog Item 887320: SaaS App Tutorial: Apex portal update
2 parents 9e9a3f3 + ad6ff04 commit 5af8b9e

File tree

1 file changed

+71
-136
lines changed

1 file changed

+71
-136
lines changed

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

Lines changed: 71 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Tutorial: Azure Active Directory integration with Apex Portal | Microsoft Docs'
2+
title: 'Tutorial: Azure Active Directory single sign-on (SSO) integration with Apex Portal | Microsoft Docs'
33
description: Learn how to configure single sign-on between Azure Active Directory and Apex Portal.
44
services: active-directory
55
documentationCenter: na
@@ -12,35 +12,33 @@ ms.service: active-directory
1212
ms.subservice: saas-app-tutorial
1313
ms.workload: identity
1414
ms.tgt_pltfrm: na
15-
ms.devlang: na
1615
ms.topic: tutorial
17-
ms.date: 04/15/2019
16+
ms.date: 01/03/2020
1817
ms.author: jeedes
1918

2019
ms.collection: M365-identity-device-management
2120
---
22-
# Tutorial: Azure Active Directory integration with Apex Portal
2321

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

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

31-
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).
32-
If you don't have an Azure subscription, [create a free account](https://azure.microsoft.com/free/) before you begin.
26+
* Control in Azure AD who has access to Apex Portal.
27+
* Enable your users to be automatically signed-in to Apex Portal with their Azure AD accounts.
28+
* Manage your accounts in one central location - the Azure portal.
29+
30+
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).
3331

3432
## Prerequisites
3533

36-
To configure Azure AD integration with Apex Portal, you need the following items:
34+
To get started, you need the following items:
3735

38-
* 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/)
39-
* Apex Portal single sign-on enabled subscription
36+
* An Azure AD subscription. If you don't have a subscription, you can get a [free account](https://azure.microsoft.com/free/).
37+
* Apex Portal single sign-on (SSO) enabled subscription.
4038

4139
## Scenario description
4240

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

4543
* Apex Portal supports **IDP** initiated SSO
4644
* Apex Portal supports **Just In Time** user provisioning
@@ -49,74 +47,52 @@ In this tutorial, you configure and test Azure AD single sign-on in a test envir
4947

5048
To configure the integration of Apex Portal into Azure AD, you need to add Apex Portal from the gallery to your list of managed SaaS apps.
5149

52-
**To add Apex Portal 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-
56-
![The Azure Active Directory button](common/select-azuread.png)
57-
58-
2. Navigate to **Enterprise Applications** and then select the **All Applications** option.
59-
60-
![The Enterprise applications blade](common/enterprise-applications.png)
61-
62-
3. To add new application, click **New application** button on the top of dialog.
63-
64-
![The New application button](common/add-new-app.png)
65-
66-
4. In the search box, type **Apex Portal**, select **Apex Portal** from result panel then click **Add** button to add the application.
67-
68-
![Apex Portal in the results list](common/search-new-app.png)
69-
70-
## Configure and test Azure AD single sign-on
71-
72-
In this section, you configure and test Azure AD single sign-on with Apex Portal 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 Apex Portal needs to be established.
74-
75-
To configure and test Azure AD single sign-on with Apex Portal, you need to complete the following building blocks:
50+
1. Sign in to the [Azure portal](https://portal.azure.com) using either a work or school account, or a personal Microsoft account.
51+
1. On the left navigation pane, select the **Azure Active Directory** service.
52+
1. Navigate to **Enterprise Applications** and then select **All Applications**.
53+
1. To add new application, select **New application**.
54+
1. In the **Add from the gallery** section, type **Apex Portal** in the search box.
55+
1. Select **Apex Portal** from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
7656

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 Apex Portal Single Sign-On](#configure-apex-portal-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 Apex Portal test user](#create-apex-portal-test-user)** - to have a counterpart of Britta Simon in Apex Portal 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.
57+
## Configure and test Azure AD single sign-on for Apex Portal
8358

84-
### Configure Azure AD single sign-on
59+
Configure and test Azure AD SSO with Apex Portal 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 Apex Portal.
8560

86-
In this section, you enable Azure AD single sign-on in the Azure portal.
61+
To configure and test Azure AD SSO with Apex Portal, complete the following building blocks:
8762

88-
To configure Azure AD single sign-on with Apex Portal, perform the following steps:
63+
1. **[Configure Azure AD SSO](#configure-azure-ad-sso)** - to enable your users to use this feature.
64+
* **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with B.Simon.
65+
* **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable B.Simon to use Azure AD single sign-on.
66+
1. **[Configure Apex Portal SSO](#configure-apex-portal-sso)** - to configure the single sign-on settings on application side.
67+
* **[Create Apex Portal test user](#create-apex-portal-test-user)** - to have a counterpart of B.Simon in Apex Portal that is linked to the Azure AD representation of user.
68+
1. **[Test SSO](#test-sso)** - to verify whether the configuration works.
8969

90-
1. In the [Azure portal](https://portal.azure.com/), on the **Apex Portal** application integration page, select **Single sign-on**.
70+
## Configure Azure AD SSO
9171

92-
![Configure single sign-on link](common/select-sso.png)
72+
Follow these steps to enable Azure AD SSO in the Azure portal.
9373

94-
2. On the **Select a Single sign-on method** dialog, select **SAML/WS-Fed** mode to enable single sign-on.
74+
1. In the [Azure portal](https://portal.azure.com/), on the **Apex Portal** application integration page, find the **Manage** section and select **single sign-on**.
75+
1. On the **Select a single sign-on method** page, select **SAML**.
76+
1. On the **Set up single sign-on with SAML** page, click the edit/pen icon for **Basic SAML Configuration** to edit the settings.
9577

96-
![Single sign-on select mode](common/select-saml-option.png)
78+
![Edit Basic SAML Configuration](common/edit-urls.png)
9779

98-
3. On the **Set up Single Sign-On with SAML** page, click **Edit** icon to open **Basic SAML Configuration** dialog.
99-
100-
![Edit Basic SAML Configuration](common/edit-urls.png)
101-
102-
4. On the **Set up Single Sign-On with SAML** page, perform the following steps:
103-
104-
![Apex Portal Domain and URLs single sign-on information](common/idp-intiated.png)
80+
1. On the **Set up single sign-on with SAML** page, enter the values for the following fields:
10581

10682
a. In the **Identifier** text box, type a URL using the following pattern:
107-
`https://<customer name>.apexportal.net/saml/sso.aspx`
83+
`https://<customer name>.apexanalytix.com/saml/sso.aspx`
10884

10985
b. In the **Reply URL** text box, type a URL using the following pattern:
110-
`https://<customer name>.apexportal.net/saml/sso.aspx`
86+
`https://<customer name>.apexanalytix.com/saml/sso.aspx`
11187

11288
> [!NOTE]
11389
> These values are not real. Update these values with the actual Identifier and Reply URL. Contact [Apex Portal Client support team](mailto:[email protected]) to get these values. You can also refer to the patterns shown in the **Basic SAML Configuration** section in the Azure portal.
11490

115-
5. Apex Portal application expects the SAML assertions in a specific format. Configure the following claims for this application. You can manage the values of these attributes from the **User Attributes** section on application integration page. On the **Set up Single Sign-On with SAML** page, click **Edit** button to open **User Attributes** dialog.
91+
1. Apex Portal 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.
11692

117-
![image](common/edit-attribute.png)
93+
![image](common/default-attributes.png)
11894

119-
6. In the **User Claims** section on the **User Attributes** dialog, edit the claims by using **Edit icon** or add the claims by using **Add new claim** to configure SAML token attribute as shown in the image above and perform the following steps:
95+
1. In addition to above, Apex Portal 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 requirements.
12096

12197
| Name | Source Attribute|
12298
| -------- | --------- |
@@ -125,109 +101,68 @@ To configure Azure AD single sign-on with Apex Portal, perform the following ste
125101
| MAIL | user.mail |
126102
| | |
127103

128-
a. Click **Add new claim** to open the **Manage user claims** dialog.
129-
130-
![image](common/new-save-attribute.png)
131-
132-
![image](common/new-attribute-details.png)
133-
134-
b. In the **Name** textbox, type the attribute name shown for that row.
135-
136-
c. Leave the **Namespace** blank.
137-
138-
d. Select Source as **Attribute**.
139-
140-
e. From the **Source attribute** list, type the attribute value shown for that row.
141-
142-
f. Click **Ok**
143-
144-
g. Click **Save**.
145-
146-
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.
104+
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.
147105

148106
![The Certificate download link](common/metadataxml.png)
149107

150-
8. On the **Set up Apex Portal** section, copy the appropriate URL(s) as per your requirement.
108+
1. On the **Set up Apex Portal** section, copy the appropriate URL(s) based on your requirement.
151109

152110
![Copy configuration URLs](common/copy-configuration-urls.png)
153111

154-
a. Login URL
155-
156-
b. Azure AD Identifier
157-
158-
c. Logout URL
159-
160-
### Configure Apex Portal Single Sign-On
161-
162-
To configure single sign-on on **Apex Portal** side, you need to send the downloaded **Federation Metadata XML** and appropriate copied URLs from Azure portal to [Apex Portal support team](mailto:[email protected]). They set this setting to have the SAML SSO connection set properly on both sides.
163-
164112
### Create an Azure AD test user
165113

166-
The objective of this section is to create a test user in the Azure portal called Britta Simon.
167-
168-
1. In the Azure portal, in the left pane, select **Azure Active Directory**, select **Users**, and then select **All users**.
169-
170-
![The "Users and groups" and "All users" links](common/users.png)
171-
172-
2. Select **New user** at the top of the screen.
173-
174-
![New user Button](common/new-user.png)
114+
In this section, you'll create a test user in the Azure portal called B.Simon.
175115

176-
3. In the User properties, perform the following steps.
177-
178-
![The User dialog box](common/user-properties.png)
179-
180-
a. In the **Name** field enter **BrittaSimon**.
181-
182-
b. In the **User name** field type `brittasimon\@yourcompanydomain.extension`. For example, [email protected].
183-
184-
c. Select **Show password** check box, and then write down the value that's displayed in the Password box.
185-
186-
d. Click **Create**.
116+
1. From the left pane in the Azure portal, select **Azure Active Directory**, select **Users**, and then select **All users**.
117+
1. Select **New user** at the top of the screen.
118+
1. In the **User** properties, follow these steps:
119+
1. In the **Name** field, enter `B.Simon`.
120+
1. In the **User name** field, enter the [email protected]. For example, `[email protected]`.
121+
1. Select the **Show password** check box, and then write down the value that's displayed in the **Password** box.
122+
1. Click **Create**.
187123

188124
### Assign the Azure AD test user
189125

190-
In this section, you enable Britta Simon to use Azure single sign-on by granting access to Apex Portal.
191-
192-
1. In the Azure portal, select **Enterprise Applications**, select **All applications**, then select **Apex Portal**.
193-
194-
![Enterprise applications blade](common/enterprise-applications.png)
126+
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to Apex Portal.
195127

196-
2. In the applications list, select **Apex Portal**.
128+
1. In the Azure portal, select **Enterprise Applications**, and then select **All applications**.
129+
1. In the applications list, select **Apex Portal**.
130+
1. In the app's overview page, find the **Manage** section and select **Users and groups**.
197131

198-
![The Apex Portal link in the Applications list](common/all-applications.png)
132+
![The "Users and groups" link](common/users-groups-blade.png)
199133

200-
3. In the menu on the left, select **Users and groups**.
134+
1. Select **Add user**, then select **Users and groups** in the **Add Assignment** dialog.
201135

202-
![The "Users and groups" link](common/users-groups-blade.png)
136+
![The Add User link](common/add-assign-user.png)
203137

204-
4. Click the **Add user** button, then select **Users and groups** in the **Add Assignment** dialog.
138+
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.
139+
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.
140+
1. In the **Add Assignment** dialog, click the **Assign** button.
205141

206-
![The Add Assignment pane](common/add-assign-user.png)
142+
## Configure Apex Portal SSO
207143

208-
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.
209-
210-
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.
211-
212-
7. In the **Add Assignment** dialog click the **Assign** button.
144+
To configure single sign-on on **Apex Portal** side, you need to send the downloaded **Federation Metadata XML** and appropriate copied URLs from Azure portal to [Apex Portal support team](mailto:[email protected]). They set this setting to have the SAML SSO connection set properly on both sides.
213145

214146
### Create Apex Portal test user
215147

216148
In this section, a user called Britta Simon is created in Apex Portal. Apex Portal 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 Apex Portal, a new one is created after authentication.
217149

218150
> [!NOTE]
219-
> If you need to create a user manually, you need to contact the [Apex Portal support team](mailto:[email protected]).
151+
> If you need to create a user manually, you need to contact the [Apex Portal support team](mailto:[email protected]).
220152
221-
### Test single sign-on
153+
## Test SSO
222154

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

225157
When you click the Apex Portal tile in the Access Panel, you should be automatically signed in to the Apex Portal 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).
226158

227-
## Additional Resources
159+
## Additional resources
160+
161+
- [ 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)
162+
163+
- [What is application access and single sign-on with Azure Active Directory? ](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
228164

229-
- [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)
165+
- [What is conditional access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)
230166

231-
- [What is application access and single sign-on with Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
167+
- [Try Apex Portal with Azure AD](https://aad.portal.azure.com/)
232168

233-
- [What is Conditional Access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)

0 commit comments

Comments
 (0)