Skip to content

Commit 5905da0

Browse files
Merge pull request #176171 from udhaymahajan/mx3diagnostics
Added MX3 Diagnostics Connector Tutorial.
2 parents d344b75 + 965c5ba commit 5905da0

File tree

4 files changed

+162
-0
lines changed

4 files changed

+162
-0
lines changed
116 KB
Loading
144 KB
Loading
Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
---
2+
title: 'Tutorial: Configure MX3 Diagnostics Connector for automatic user provisioning with Azure Active Directory | Microsoft Docs'
3+
description: Learn how to automatically provision and de-provision user accounts from Azure AD to MX3 Diagnostics Connector.
4+
services: active-directory
5+
documentationcenter: ''
6+
author: twimmers
7+
writer: Thwimmer
8+
manager: beatrizd
9+
10+
ms.assetid: 6d54ea28-0208-45bc-8e29-c6cf9a912f00
11+
ms.service: active-directory
12+
ms.subservice: saas-app-tutorial
13+
ms.workload: identity
14+
ms.tgt_pltfrm: na
15+
ms.devlang: na
16+
ms.topic: article
17+
ms.date: 10/12/2021
18+
ms.author: Thwimmer
19+
---
20+
21+
# Tutorial: Configure MX3 Diagnostics Connector for automatic user provisioning
22+
23+
This tutorial describes the steps you need to perform in both MX3 Diagnostics Connector and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to [MX3 Diagnostics Connector](https://www.mx3diagnostics.com/) using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see [Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory](../app-provisioning/user-provisioning.md).
24+
25+
26+
## Capabilities supported
27+
> [!div class="checklist"]
28+
> * Create users in MX3 Diagnostics Connector.
29+
> * Remove users in MX3 Diagnostics Connector when they do not require access anymore.
30+
> * Keep user attributes synchronized between Azure AD and MX3 Diagnostics Connector.
31+
> * Provision groups and group memberships in MX3 Diagnostics Connector.
32+
> * Single sign-on to MX3 Diagnostics Connector.
33+
34+
## Prerequisites
35+
36+
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
37+
38+
* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md).
39+
* A user account in Azure AD with [permission](../roles/permissions-reference.md) to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
40+
* An MX3 account with organization feature.
41+
* An account in MX3 Portal with SSO.
42+
43+
## Step 1. Plan your provisioning deployment
44+
1. Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md).
45+
1. Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
46+
1. Determine what data to [map between Azure AD and MX3 Diagnostics Connector](../app-provisioning/customize-application-attributes.md).
47+
48+
## Step 2. Configure MX3 Diagnostics Connector to support provisioning with Azure AD
49+
50+
1. If your MX3 account does not have organization feature enabled, apply for organization feature as described in this [documentation](https://www.mx3diagnostics.com/files/files/MX3_PortalGuide_0321.pdf).
51+
52+
1. If your MX3 account does not have single-sign-on feature enabled, setup Azure AD SSO as described in this documentation.
53+
54+
1. Log in to [MX3 Portal](https://portal.mx3.app). Navigate to the SSO settings page by clicking on settings and then click on **Single sign-on**.
55+
56+
![Screenshot for MX3 Diagnostics Connector Single sign-on settings.](media/mx3-provisioning/sso-settings.png)
57+
58+
59+
1. Scroll down to view the token. Copy and save the token. You will need it in the **Step 5**.
60+
61+
![Screenshot of MX3 Diagnostics Connector's secret token for Azure AD.](media/mx3-provisioning/sso-settings-token.png)
62+
63+
## Step 3. Add MX3 Diagnostics Connector from the Azure AD application gallery
64+
65+
Add MX3 Diagnostics Connector from the Azure AD application gallery to start managing provisioning to MX3 Diagnostics Connector. If you have previously setup MX3 Diagnostics Connector for SSO, you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery [here](../manage-apps/add-application-portal.md).
66+
67+
## Step 4. Define who will be in scope for provisioning
68+
69+
The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following [steps](../manage-apps/assign-user-or-group-access-portal.md) to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described [here](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
70+
71+
* When assigning users and groups to MX3 Diagnostics Connector, you must select a role other than **Default Access**. Users with the Default Access role are excluded from provisioning and will be marked as not effectively entitled in the provisioning logs. If the only role available on the application is the default access role, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add more roles.
72+
73+
* Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an [attribute based scoping filter](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
74+
75+
76+
## Step 5. Configure automatic user provisioning to MX3 Diagnostics Connector
77+
78+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in MX3 Diagnostics Connector based on user and/or group assignments in Azure AD.
79+
80+
### To configure automatic user provisioning for MX3 Diagnostics Connector in Azure AD:
81+
82+
1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
83+
84+
![Screenshot that displays Enterprise applications blade.](common/enterprise-applications.png)
85+
86+
1. In the applications list, select **MX3 Diagnostics Connector**.
87+
88+
![The MX3 Diagnostics Connector link in the Applications list](common/all-applications.png)
89+
90+
1. Select the **Provisioning** tab.
91+
92+
![Screenshot of Provisioning tab and where to find it.](common/provisioning.png)
93+
94+
1. Set the **Provisioning Mode** to **Automatic**.
95+
96+
![Screenshot of Provisioning tab that shows to select automatic.](common/provisioning-automatic.png)
97+
98+
1. Under the **Admin Credentials** section, input your MX3 Diagnostics Connector Tenant URL (https://scim.mx3.app) and Secret Token. Click **Test Connection** to ensure Azure AD can connect to MX3 Diagnostics Connector. If the connection fails, ensure your MX3 Diagnostics Connector account has Admin permissions and try again.
99+
100+
![Screenshot that displays text field to enter Token and SCIM URL](common/provisioning-testconnection-tenanturltoken.png)
101+
102+
1. In the **Notification Email** field, enter the email address of a person or group who should receive the provisioning error notifications and select the **Send an email notification when a failure occurs** check box.
103+
104+
![Screenshot of a text field where you can enter email for notification.](common/provisioning-notification-email.png)
105+
106+
1. Select **Save**.
107+
108+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to MX3 Diagnostics Connector**.
109+
110+
1. Review the user attributes that are synchronized from Azure AD to MX3 Diagnostics Connector in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in MX3 Diagnostics Connector for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you will need to ensure that the MX3 Diagnostics Connector API supports filtering users based on that attribute. Select the **Save** button to commit any changes.
111+
112+
|Attribute|Type|Supported for filtering|
113+
|---|---|---|
114+
|userName|String|✓
115+
|externalId|String|✓
116+
|active|Boolean|
117+
|name.givenName|String|
118+
|name.familyName|String|
119+
120+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Groups to MX3 Diagnostics Connector**.
121+
122+
1. Review the group attributes that are synchronized from Azure AD to MX3 Diagnostics Connector in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the groups in MX3 Diagnostics Connector for update operations. Select the **Save** button to commit any changes.
123+
124+
|Attribute|Type|Supported for filtering|
125+
|---|---|---|
126+
|displayName|String|✓
127+
|externalId|String|
128+
|members|Reference|
129+
130+
1. To configure scoping filters, refer to the following instructions provided in the [Scoping filter tutorial](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
131+
132+
1. To enable the Azure AD provisioning service for MX3 Diagnostics Connector, change the **Provisioning Status** to **On** in the **Settings** section.
133+
134+
![Provisioning Status Toggled On](common/provisioning-toggle-on.png)
135+
136+
1. Define the users and/or groups that you would like to provision to MX3 Diagnostics Connector by choosing the desired values in **Scope** in the **Settings** section.
137+
138+
![Provisioning Scope](common/provisioning-scope.png)
139+
140+
1. When you are ready to provision, click **Save**.
141+
142+
![Saving Provisioning Configuration](common/provisioning-configuration-save.png)
143+
144+
This operation starts the initial synchronization cycle of all users and groups defined in **Scope** in the **Settings** section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.
145+
146+
## Step 6. Monitor your deployment
147+
Once you've configured provisioning, use the following resources to monitor your deployment:
148+
149+
* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully
150+
* Check the [progress bar](../app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user.md) to see the status of the provisioning cycle and how close it is to completion
151+
* If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states [here](../app-provisioning/application-provisioning-quarantine-status.md).
152+
153+
## More resources
154+
155+
* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md)
156+
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
157+
158+
## Next steps
159+
160+
* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md)

articles/active-directory/saas-apps/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2589,6 +2589,8 @@
25892589
href: miro-provisioning-tutorial.md
25902590
- name: monday.com
25912591
href: mondaycom-provisioning-tutorial.md
2592+
- name: MX3 Diagnostics
2593+
href: mx3-diagnostics-connector-provisioning-tutorial.md
25922594
- name: myPolicies
25932595
href: mypolicies-provisioning-tutorial.md
25942596
- name: N - S

0 commit comments

Comments
 (0)