Edit

Tutorial: Configure uniFlow Online for automatic user provisioning

  • Article

This tutorial describes the steps you need to perform in both uniFlow Online and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users to uniFlow Online 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.

Supported capabilities

  • Create users in uniFlow Online.
  • Disable users in uniFLOW Online.
  • Remove users in uniFlow Online when they do not require access anymore.
  • Keep user attributes synchronized between Microsoft Entra ID and uniFlow Online.
  • Single sign-on to uniFlow Online (recommended).

Prerequisites

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

  • A Microsoft Entra tenant
  • A user account in Microsoft Entra ID with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
  • An administrator account with uniFlow Online.

Step 1: Plan your provisioning deployment

  1. Learn about how the provisioning service works.
  2. Determine who will be in scope for provisioning.
  3. Determine what data to map between Microsoft Entra ID and uniFlow Online.

Step 2: Configure uniFlow Online to support provisioning with Microsoft Entra ID

  • In a different web browser window, sign in to uniFLOW Online website as an administrator.
  • Select Extensions tab > Identity Providers > Configure identity providers.
  • Click on Add identity provider. On the ADD IDENTITY PROVIDER section, perform the following steps:
    • Enter the Display name .
    • For Provider type, select WS-Federation option from the dropdown.
    • For WS-Federation type, select Microsoft Entra ID option from the dropdown.
    • Click Save.
  • Enable the Advanced Administrative View within your user Profile settings by navigating to Profile settings > Administrator view and setting it to Advanced.
  • The provisioning tab will now be available within the Identity Provider configuration.
  • Click Enable Provisioning when you are ready to set up user provisioning in your company's Microsoft Entra ID.
    • Provisioning tenant URL (only displayed once after Provisioning is enabled): You need this URL when setting up provisioning in your Microsoft Entra application.
    • Provisioning secret token (only displayed once after Provisioning is enabled): You need this token when setting up provisioning in your Microsoft Entra application.

Add uniFlow Online from the Microsoft Entra application gallery to start managing provisioning to uniFlow Online. If you have previously setup uniFlow Online 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 will be in scope for provisioning

The Microsoft Entra provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users 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.

  • Start small. Test with a small set of users before rolling out to everyone. When scope for provisioning is set to assigned users, you can control this by assigning one or two users to the app. When scope is set to all users, 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 uniFlow Online

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

To configure automatic user provisioning for uniFlow Online 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 uniFlow Online.

    Screenshot of the uniFlow Online 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. Under the Admin Credentials section, input your uniFlow Online Tenant URL and Secret Token. Click Test Connection to ensure Microsoft Entra ID can connect to uniFlow Online. If the connection fails, ensure your uniFlow Online 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 and select the Send an email notification when a failure occurs check box.

    Screenshot of Notification Email.

  8. Select Save.

  9. Under the Mappings section, select Synchronize Microsoft Entra users to uniFlow Online.

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

    Attribute Type Supported for filtering Required by uniFlow Online
    userName String ✓ ✓
    externalId String ✓ ✓
    emails[type eq "work"].value String ✓
    active Boolean ✓
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department String
    displayName String
    title String
    addresses[type eq "work"].streetAddress String
    title String
    phoneNumbers[type eq "work"].value String
    urn:ietf:params:scim:schemas:extension:uniFLOWOnline:2.0:User:cardNumber String
    urn:ietf:params:scim:schemas:extension:uniFLOWOnline:2.0:User:cardRegistrationCode String
    urn:ietf:params:scim:schemas:extension:uniFLOWOnline:2.0:User:localUsername String
    urn:ietf:params:scim:schemas:extension:uniFLOWOnline:2.0:User:pin String

  11. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

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

    Screenshot of Provisioning Status Toggled On.

  13. Define the users that you would like to provision to uniFlow Online by choosing the desired values in Scope in the Settings section.

    Screenshot of Provisioning Scope.

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

    Screenshot of Saving Provisioning Configuration.

This operation starts the initial synchronization cycle of all users 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 Microsoft Entra provisioning service is running.

Step 6: Monitor your deployment

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

  • Use the provisioning logs to determine which users have been 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. Learn more about quarantine states here.

More resources

Next steps