Edit

Share via

Tutorial: Configure Insite LMS for automatic user provisioning

  • Article

This tutorial describes the steps you need to do in both Insite LMS and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and deprovisions users and groups to Insite LMS using the Microsoft Entra 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 Microsoft Entra ID.

Capabilities Supported

  • Create users in Insite LMS
  • Remove users in Insite LMS when they do not require access anymore
  • Keep user attributes synchronized between Microsoft Entra ID and Insite LMS

Prerequisites

The scenario outlined in this tutorial assumes that you already have the following prerequisites:

Step 1: Plan your provisioning deployment

  1. Learn about how the provisioning service works.
  2. Determine who is in scope for provisioning.
  3. Determine what data to map between Microsoft Entra ID and Insite LMS.

Step 2: Configure Insite LMS to support provisioning with Microsoft Entra ID

To generate the Secret Token

  1. Log in to Insite LMS Console with your Admin account.

  2. Navigate to Applications module on the left hand side menu.

  3. In the section Self hosted Jobs, you'll find a job named “SCIM”. If you can't find the job, contact the Insite LMS support team.

    Screenshot of generate API Key.

  4. Click on Generate Api Key. Copy and save the Api Key. This value is entered in the Secret Token field in the Provisioning tab of your Insite LMS application.

Note

The Api Key is only valid for 1 year and needs to be renewed manually before it expires.

Add Insite LMS from the Microsoft Entra application gallery to start managing provisioning to Insite LMS. If you have previously setup Insite LMS 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.

Step 4: Define who is in scope for provisioning

The Microsoft Entra provisioning service allows you to scope who is provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who is provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who is provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.

  • 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.

  • If you need more roles, you can update the application manifest to add new roles.

Step 5: Configure automatic user provisioning to Insite LMS

This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users and/or groups in Insite LMS app based on user and group assignments in Microsoft Entra ID.

To configure automatic user provisioning for Insite LMS in Microsoft Entra ID:

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications

    Screenshot of Enterprise applications blade.

  3. In the applications list, select Insite LMS.

    Screenshot of The Insite LMS link in the Applications list.

  4. Select the Provisioning tab.

    Screenshot of Provisioning tab.

  5. Set the Provisioning Mode to Automatic.

    Screenshot of Provisioning tab automatic.

  6. In the Admin Credentials section, enter your Insite LMS Tenant URL as https://api.insitelms.net/scim and enter the Secret token generated in Step 2 above. Select Test Connection to ensure that Microsoft Entra ID can connect to Insite LMS. If the connection fails, ensure that your Insite LMS account has admin permissions and try again.

    Screenshot of Token.

  7. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications. Select the Send an email notification when a failure occurs check box.

    Screenshot of Notification Email.

  8. Select Save.

  9. In the Mappings section, select Synchronize Microsoft Entra users to Insite LMS.

  10. Review the user attributes that are synchronized from Microsoft Entra ID to Insite LMS in the Attribute Mapping section. The attributes selected as Matching properties are used to match the user accounts in Insite LMS for update operations. If you change the matching target attribute, you need to ensure that the Insite LMS API supports filtering users based on that attribute. Select Save to commit any changes.

    Attribute Type Supported for filtering Required by Insite LMS
    userName String ✓ ✓
    emails[type eq "work"].value String ✓ ✓
    active Boolean
    name.givenName String
    name.familyName String
    phoneNumbers[type eq "work"].value String

  11. To configure scoping filters, see the instructions provided in the Scoping filter tutorial.

  12. To enable the Microsoft Entra provisioning service for Insite LMS, change Provisioning Status to On in the Settings section.

    Screenshot of Provisioning Status Toggled On.

  13. Define the users or groups that you want to provision to Insite LMS by selecting the desired values in Scope in the Settings section.

    Screenshot of Provisioning Scope.

  14. When you're ready to provision, select Save.

    Screenshot of Saving Provisioning Configuration.

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 do than next cycles, which occur about every 40 minutes as long as the Microsoft Entra provisioning service is running.

Step 6: Monitor your deployment

After you've configured provisioning, use the following resources to monitor your deployment:

  • Use the provisioning logs to determine which users were provisioned successfully or unsuccessfully.
  • Check the progress bar to see the status of the provisioning cycle and how close it's to completion.
  • If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. To learn more about quarantine states, see Application provisioning status of quarantine.

More resources

Next steps