Skip to content

Commit e09d7b7

Browse files
authored
Merge pull request #247237 from Harshita-130901/New-Provisioning-Tutorials
Provisioning Tutorials
2 parents a99031a + 3f0ddd9 commit e09d7b7

7 files changed

+640
-9
lines changed

articles/active-directory/saas-apps/g-suite-provisioning-tutorial.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,6 @@ Now any end user that was made eligible for the group in PIM can get JIT access
293293
* 10/17/2020 - Added support for more G Suite user and group attributes.
294294
* 10/17/2020 - Updated G Suite target attribute names to match what is defined [here](https://developers.google.com/admin-sdk/directory).
295295
* 10/17/2020 - Updated default attribute mappings.
296-
* 03/18/2021 - Manager email is now synchronized instead of ID for all new users. For any existing users that were provisioned with a manager as an ID, you can do a restart through [Microsoft Graph](/graph/api/synchronization-synchronizationjob-restart?preserve-view=true&tabs=http&view=graph-rest-beta) with scope "full" to ensure that the email is provisioned. This change only impacts the GSuite provisioning job and not the older provisioning job beginning with Goov2OutDelta. Note, the manager email is provisioned when the user is first created or when the manager changes. The manager email isn't provisioned if the manager changes their email address.
297296

298297
## More resources
299298

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
title: 'Tutorial: Configure SAP Litmos for automatic user provisioning with Azure Active Directory'
3+
description: Learn how to automatically provision and de-provision user accounts from Azure AD to SAP Litmos.
4+
services: active-directory
5+
author: twimmers
6+
writer: twimmers
7+
manager: jeedes
8+
ms.assetid: 4e0d2a0b-2d22-4b21-8b29-64413549c5a5
9+
ms.service: active-directory
10+
ms.subservice: saas-app-tutorial
11+
ms.workload: identity
12+
ms.topic: tutorial
13+
ms.date: 08/03/2023
14+
ms.author: thwimmer
15+
---
16+
17+
# Tutorial: Configure SAP Litmos for automatic user provisioning
18+
19+
This tutorial describes the steps you need to perform in both SAP Litmos and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to [SAP Litmos](http://www.litmos.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).
20+
21+
22+
## Supported capabilities
23+
> [!div class="checklist"]
24+
> * Create users in SAP Litmos.
25+
> * Remove users in SAP Litmos when they do not require access anymore.
26+
> * Keep user attributes synchronized between Azure AD and SAP Litmos.
27+
> * Provision groups and group memberships in SAP Litmos.
28+
> * [Single sign-on](litmos-tutorial.md) to SAP Litmos (recommended).
29+
30+
## Prerequisites
31+
32+
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
33+
34+
* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md).
35+
* 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).
36+
* An SAP Litmos tenant.
37+
* A user account in SAP Litmos with Admin permissions.
38+
39+
## Step 1. Plan your provisioning deployment
40+
1. Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md).
41+
1. Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
42+
1. Determine what data to [map between Azure AD and SAP Litmos](../app-provisioning/customize-application-attributes.md).
43+
44+
## Step 2. Configure SAP Litmos to support provisioning with Azure AD
45+
Contact SAP Litmos support to configure SAP Litmos to support provisioning with Azure AD.
46+
47+
## Step 3. Add SAP Litmos from the Azure AD application gallery
48+
49+
Add SAP Litmos from the Azure AD application gallery to start managing provisioning to SAP Litmos. If you have previously setup SAP Litmos for SSO you can use the same application. However it's 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).
50+
51+
## Step 4. Define who will be in scope for provisioning
52+
53+
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).
54+
55+
* 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).
56+
57+
* If you need more roles, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add new roles.
58+
59+
60+
## Step 5. Configure automatic user provisioning to SAP Litmos
61+
62+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Azure AD.
63+
64+
### To configure automatic user provisioning for SAP Litmos in Azure AD:
65+
66+
1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
67+
68+
![Screenshot of Enterprise applications blade.](common/enterprise-applications.png)
69+
70+
1. In the applications list, select **SAP Litmos**.
71+
72+
![Screenshot of the SAP Litmos link in the Applications list.](common/all-applications.png)
73+
74+
1. Select the **Provisioning** tab.
75+
76+
![Screenshot of Provisioning tab.](common/provisioning.png)
77+
78+
1. Set the **Provisioning Mode** to **Automatic**.
79+
80+
![Screenshot of Provisioning tab automatic.](common/provisioning-automatic.png)
81+
82+
1. Under the **Admin Credentials** section, input your SAP Litmos Tenant URL and Secret Token. Click **Test Connection** to ensure Azure AD can connect to SAP Litmos. If the connection fails, ensure your SAP Litmos account has Admin permissions and try again.
83+
84+
![Screenshot of Token.](common/provisioning-testconnection-tenanturltoken.png)
85+
86+
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.
87+
88+
![Screenshot of Notification Email.](common/provisioning-notification-email.png)
89+
90+
1. Select **Save**.
91+
92+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to SAP Litmos**.
93+
94+
1. Review the user attributes that are synchronized from Azure AD to SAP Litmos in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in SAP Litmos for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you'll need to ensure that the SAP Litmos API supports filtering users based on that attribute. Select the **Save** button to commit any changes.
95+
96+
|Attribute|Type|Supported for filtering|Required by SAP Litmos|
97+
|---|---|---|---|
98+
|userName|String|✓|✓
99+
|active|Boolean||✓
100+
|title|String||
101+
|emails[type eq "work"].value|String||
102+
|preferredLanguage|String||
103+
|name.givenName|String||✓
104+
|name.familyName|String||✓
105+
|addresses[type eq "work"].streetAddress|String||
106+
|addresses[type eq "work"].locality|String||
107+
|addresses[type eq "work"].region|String||
108+
|addresses[type eq "work"].postalCode|String||
109+
|addresses[type eq "work"].country|String||
110+
|phoneNumbers[type eq "work"].value|String||
111+
|phoneNumbers[type eq "mobile"].value|String||
112+
|timezone|String||
113+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber|String||
114+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization|String||
115+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager|Reference||
116+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField1|String||
117+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField2|String||
118+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField3|String||
119+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField4|String||
120+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField5|String||
121+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField6|String||
122+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField7|String||
123+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField8|String||
124+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField9|String||
125+
|urn:ietf:params:scim:schemas:extension:Litmos:2.0:User:CustomField:CustomField10|String||
126+
127+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Groups to SAP Litmos**.
128+
129+
1. Review the group attributes that are synchronized from Azure AD to SAP Litmos in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the groups in SAP Litmos for update operations. Select the **Save** button to commit any changes.
130+
131+
|Attribute|Type|Supported for filtering|Required by SAP Litmos|
132+
|---|---|---|---|
133+
|displayName|String|✓|✓
134+
|members|Reference||
135+
136+
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).
137+
138+
1. To enable the Azure AD provisioning service for SAP Litmos, change the **Provisioning Status** to **On** in the **Settings** section.
139+
140+
![Screenshot of Provisioning Status Toggled On.](common/provisioning-toggle-on.png)
141+
142+
1. Define the users and/or groups that you would like to provision to SAP Litmos by choosing the desired values in **Scope** in the **Settings** section.
143+
144+
![Screenshot of Provisioning Scope.](common/provisioning-scope.png)
145+
146+
1. When you're ready to provision, click **Save**.
147+
148+
![Screenshot of Saving Provisioning Configuration.](common/provisioning-configuration-save.png)
149+
150+
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.
151+
152+
## Step 6. Monitor your deployment
153+
Once you've configured provisioning, use the following resources to monitor your deployment:
154+
155+
* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully
156+
* 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's to completion
157+
* If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states [here](../app-provisioning/application-provisioning-quarantine-status.md).
158+
159+
## More resources
160+
161+
* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md)
162+
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
163+
164+
## Next steps
165+
166+
* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md)

0 commit comments

Comments
 (0)