|
| 1 | +--- |
| 2 | +title: 'Tutorial: Azure Active Directory integration with Apex Portal | Microsoft Docs' |
| 3 | +description: Learn how to configure single sign-on between Azure Active Directory and Apex Portal. |
| 4 | +services: active-directory |
| 5 | +documentationCenter: na |
| 6 | +author: jeevansd |
| 7 | +manager: femila |
| 8 | +ms.reviewer: joflore |
| 9 | + |
| 10 | +ms.assetid: db204a46-6460-4ace-bdbb-4353846723ad |
| 11 | +ms.service: active-directory |
| 12 | +ms.workload: identity |
| 13 | +ms.tgt_pltfrm: na |
| 14 | +ms.devlang: na |
| 15 | +ms.topic: article |
| 16 | +ms.date: 11/07/2017 |
| 17 | +ms.author: jeedes |
| 18 | + |
| 19 | +--- |
| 20 | +# Tutorial: Azure Active Directory integration with Apex Portal |
| 21 | + |
| 22 | +In this tutorial, you learn how to integrate Apex Portal with Azure Active Directory (Azure AD). |
| 23 | + |
| 24 | +Integrating Apex Portal with Azure AD provides you with the following benefits: |
| 25 | + |
| 26 | +- You can control in Azure AD who has access to Apex Portal. |
| 27 | +- You can enable your users to automatically get signed-on to Apex Portal (Single Sign-On) with their Azure AD accounts. |
| 28 | +- You can manage your accounts in one central location - the Azure portal. |
| 29 | + |
| 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](active-directory-appssoaccess-whatis.md). |
| 31 | + |
| 32 | +## Prerequisites |
| 33 | + |
| 34 | +To configure Azure AD integration with Apex Portal, you need the following items: |
| 35 | + |
| 36 | +- An Azure AD subscription |
| 37 | +- A Apex Portal single sign-on enabled subscription |
| 38 | + |
| 39 | +> [!NOTE] |
| 40 | +> To test the steps in this tutorial, we do not recommend using a production environment. |
| 41 | +
|
| 42 | +To test the steps in this tutorial, you should follow these recommendations: |
| 43 | + |
| 44 | +- Do not use your production environment, unless it is necessary. |
| 45 | +- If you don't have an Azure AD trial environment, you can [get a one-month trial](https://azure.microsoft.com/pricing/free-trial/). |
| 46 | + |
| 47 | +## Scenario description |
| 48 | +In this tutorial, you test Azure AD single sign-on in a test environment. |
| 49 | +The scenario outlined in this tutorial consists of two main building blocks: |
| 50 | + |
| 51 | +1. Adding Apex Portal from the gallery |
| 52 | +2. Configuring and testing Azure AD single sign-on |
| 53 | + |
| 54 | +## Adding Apex Portal from the gallery |
| 55 | +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. |
| 56 | + |
| 57 | +**To add Apex Portal from the gallery, perform the following steps:** |
| 58 | + |
| 59 | +1. In the **[Azure portal](https://portal.azure.com)**, on the left navigation panel, click **Azure Active Directory** icon. |
| 60 | + |
| 61 | + ![The Azure Active Directory button][1] |
| 62 | + |
| 63 | +2. Navigate to **Enterprise applications**. Then go to **All applications**. |
| 64 | + |
| 65 | + ![The Enterprise applications blade][2] |
| 66 | + |
| 67 | +3. To add new application, click **New application** button on the top of dialog. |
| 68 | + |
| 69 | + ![The New application button][3] |
| 70 | + |
| 71 | +4. In the search box, type **Apex Portal**, select **Apex Portal** from result panel then click **Add** button to add the application. |
| 72 | + |
| 73 | +  |
| 74 | + |
| 75 | +## Configure and test Azure AD single sign-on |
| 76 | + |
| 77 | +In this section, you configure and test Azure AD single sign-on with Apex Portal based on a test user called "Britta Simon". |
| 78 | + |
| 79 | +For single sign-on to work, Azure AD needs to know what the counterpart user in Apex Portal is to a user in Azure AD. In other words, a link relationship between an Azure AD user and the related user in Apex Portal needs to be established. |
| 80 | + |
| 81 | +In Apex Portal, assign the value of the **user name** in Azure AD as the value of the **Username** to establish the link relationship. |
| 82 | + |
| 83 | +To configure and test Azure AD single sign-on with Apex Portal, you need to complete the following building blocks: |
| 84 | + |
| 85 | +1. **[Configure Azure AD Single Sign-On](#configure-azure-ad-single-sign-on)** - to enable your users to use this feature. |
| 86 | +2. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon. |
| 87 | +3. **[Create an Apex Portal test user](#create-an-apex-online-test-user)** - to have a counterpart of Britta Simon in Apex Portal that is linked to the Azure AD representation of user. |
| 88 | +4. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on. |
| 89 | +5. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works. |
| 90 | + |
| 91 | +### Configure Azure AD single sign-on |
| 92 | + |
| 93 | +In this section, you enable Azure AD single sign-on in the Azure portal and configure single sign-on in your Apex Portal application. |
| 94 | + |
| 95 | +**To configure Azure AD single sign-on with Apex Portal, perform the following steps:** |
| 96 | + |
| 97 | +1. In the Azure portal, on the **Apex Portal** application integration page, click **Single sign-on**. |
| 98 | + |
| 99 | + ![Configure single sign-on link][4] |
| 100 | + |
| 101 | +2. On the **Single sign-on** dialog, select **Mode** as **SAML-based Sign-on** to enable single sign-on. |
| 102 | + |
| 103 | +  |
| 104 | + |
| 105 | +3. On the **Apex Portal Domain and URLs** section, perform the following steps: |
| 106 | + |
| 107 | +  |
| 108 | + |
| 109 | + a. In the **Identifier** textbox, type a URL using the following pattern: `https://<customer name>.apexanalytix.com/saml/sso.aspx` |
| 110 | + |
| 111 | + b. In the **Reply URL** textbox, type a URL using the following pattern: `https://<customer name>.apexanalytix.com/saml/sso.aspx` |
| 112 | + |
| 113 | + > [!NOTE] |
| 114 | + > These values are not real. Update these values with the actual Identifier and Reply URL. Contact [Apex Portal support team](mailto:support@apexanalytix.com) to get these values. |
| 115 | + |
| 116 | +4. The 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. Configure the following claims for this application. You can manage the values of these attributes from the "**User Attributes**" section on application integration page. |
| 117 | + |
| 118 | +  |
| 119 | + |
| 120 | +5. In the **User Attributes** section on the **Single sign-on** dialog, configure SAML token attribute as shown in the preceding image and perform the following steps: |
| 121 | + |
| 122 | + | Attribute Name | Attribute Value | |
| 123 | + | ------------------- | -------------------- | |
| 124 | + | FIRSTNAME | user.givenname | |
| 125 | + | LASTNAME | user.surname | |
| 126 | + | MAIL | user.mail | |
| 127 | + |
| 128 | + a. Click **Add attribute** to open the **Add Attribute** dialog. |
| 129 | + |
| 130 | +  |
| 131 | + |
| 132 | +  |
| 133 | + |
| 134 | + b. In the **Name** textbox, type the attribute name shown for that row. |
| 135 | + |
| 136 | + c. From the **Value** list, type the attribute value shown for that row. |
| 137 | + |
| 138 | + d. Click **Ok**. |
| 139 | + |
| 140 | +6. On the **SAML Signing Certificate** section, click **Metadata XML** and then save the metadata file on your computer. |
| 141 | + |
| 142 | +  |
| 143 | + |
| 144 | +7. Click **Save** button. |
| 145 | + |
| 146 | +  |
| 147 | + |
| 148 | +8. To configure single sign-on on **Apex Portal** side, you need to send the downloaded **Metadata XML** to [Apex Portal support team](mailto:support@apexanalytix.com). They set this setting to have the SAML SSO connection set properly on both sides. |
| 149 | + |
| 150 | +> [!TIP] |
| 151 | +> You can now read a concise version of these instructions inside the [Azure portal](https://portal.azure.com), while you are setting up the app! After adding this app from the **Active Directory > Enterprise Applications** section, simply click the **Single Sign-On** tab and access the embedded documentation through the **Configuration** section at the bottom. You can read more about the embedded documentation feature here: [Azure AD embedded documentation]( https://go.microsoft.com/fwlink/?linkid=845985) |
| 152 | +
|
| 153 | +### Create an Azure AD test user |
| 154 | + |
| 155 | +The objective of this section is to create a test user in the Azure portal called Britta Simon. |
| 156 | + |
| 157 | + ![Create an Azure AD test user][100] |
| 158 | + |
| 159 | +**To create a test user in Azure AD, perform the following steps:** |
| 160 | + |
| 161 | +1. In the Azure portal, in the left pane, click the **Azure Active Directory** button. |
| 162 | + |
| 163 | +  |
| 164 | + |
| 165 | +2. To display the list of users, go to **Users and groups**, and then click **All users**. |
| 166 | + |
| 167 | +  |
| 168 | + |
| 169 | +3. To open the **User** dialog box, click **Add** at the top of the **All Users** dialog box. |
| 170 | + |
| 171 | +  |
| 172 | + |
| 173 | +4. In the **User** dialog box, perform the following steps: |
| 174 | + |
| 175 | +  |
| 176 | + |
| 177 | + a. In the **Name** box, type **BrittaSimon**. |
| 178 | + |
| 179 | + b. In the **User name** box, type the email address of user Britta Simon. |
| 180 | + |
| 181 | + c. Select the **Show Password** check box, and then write down the value that's displayed in the **Password** box. |
| 182 | + |
| 183 | + d. Click **Create**. |
| 184 | + |
| 185 | +### Create an Apex Portal test user |
| 186 | + |
| 187 | +The objective of this section is to create a user called Britta Simon in Apex Portal. Apex Portal supports just-in-time provisioning, which is by default enabled. There is no action item for you in this section. A new user is created during an attempt to access Apex Portal if it doesn't exist yet. |
| 188 | + |
| 189 | +> [!NOTE] |
| 190 | +> If you need to create a user manually, you need to contact the [Apex Portal support team](mailto:support@apexanalytix.com). |
| 191 | +
|
| 192 | +### Assign the Azure AD test user |
| 193 | + |
| 194 | +In this section, you enable Britta Simon to use Azure single sign-on by granting access to Apex Portal. |
| 195 | + |
| 196 | +![Assign the user role][200] |
| 197 | + |
| 198 | +**To assign Britta Simon to Apex Portal, perform the following steps:** |
| 199 | + |
| 200 | +1. In the Azure portal, open the applications view, and then navigate to the directory view and go to **Enterprise applications** then click **All applications**. |
| 201 | + |
| 202 | + ![Assign User][201] |
| 203 | + |
| 204 | +2. In the applications list, select **Apex Portal**. |
| 205 | + |
| 206 | +  |
| 207 | + |
| 208 | +3. In the menu on the left, click **Users and groups**. |
| 209 | + |
| 210 | + ![The "Users and groups" link][202] |
| 211 | + |
| 212 | +4. Click **Add** button. Then select **Users and groups** on **Add Assignment** dialog. |
| 213 | + |
| 214 | + ![The Add Assignment pane][203] |
| 215 | + |
| 216 | +5. On **Users and groups** dialog, select **Britta Simon** in the Users list. |
| 217 | + |
| 218 | +6. Click **Select** button on **Users and groups** dialog. |
| 219 | + |
| 220 | +7. Click **Assign** button on **Add Assignment** dialog. |
| 221 | + |
| 222 | +### Test single sign-on |
| 223 | + |
| 224 | +In this section, you test your Azure AD single sign-on configuration using the Access Panel. |
| 225 | + |
| 226 | +When you click the Apex Portal tile in the Access Panel, you should get automatically signed-on to your Apex Portal application. |
| 227 | +For more information about the Access Panel, see [Introduction to the Access Panel](active-directory-saas-access-panel-introduction.md). |
| 228 | + |
| 229 | +## Additional resources |
| 230 | + |
| 231 | +* [List of Tutorials on How to Integrate SaaS Apps with Azure Active Directory](active-directory-saas-tutorial-list.md) |
| 232 | +* [What is application access and single sign-on with Azure Active Directory?](active-directory-appssoaccess-whatis.md) |
| 233 | + |
| 234 | + |
| 235 | + |
| 236 | +<!--Image references--> |
| 237 | + |
| 238 | +[1]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_01.png |
| 239 | +[2]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_02.png |
| 240 | +[3]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_03.png |
| 241 | +[4]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_04.png |
| 242 | + |
| 243 | +[100]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_100.png |
| 244 | + |
| 245 | +[200]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_200.png |
| 246 | +[201]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_201.png |
| 247 | +[202]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_202.png |
| 248 | +[203]: ./media/active-directory-saas-apexportal-tutorial/tutorial_general_203.png |
| 249 | + |
0 commit comments