Tutorial: Configure frankli for automatic user provisioning

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

Capabilities supported

  • Create users in frankli.
  • Remove users in frankli when they do not require access anymore.
  • Keep user attributes synchronized between Microsoft Entra ID and frankli.
  • Single sign-on to frankli.


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.

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

Step 2: Configure frankli to support provisioning with Microsoft Entra ID

  1. Log in to Frankli using your admin account.
  2. Navigate to Admin -> Integrations -> Microsoft Entra ID. Active Directory Setup
  3. Click on Setup a Directory.
  4. Define a name for your new external directory. Active Directory Name
  5. Click on Create Directory. Active Directory Details
  6. Take note of the Base URL and the Bearer Token.The Base URL will be entered into the Tenant URL field. The Bearer Token will be entered into the Secret Token field.

Add frankli from the Microsoft Entra application gallery to start managing provisioning to frankli. If you have previously setup frankli for SSO, you can use the same application. However it's recommended 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. It's based on assignment to the application and or based on attributes of the user and group. If you choose to scope who will be 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 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 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 additional roles, you can update the application manifest to add new roles.

Step 5: Configure automatic user provisioning to frankli

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

To configure automatic user provisioning for frankli 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

    Enterprise applications blade

  3. In the applications list, select frankli.

    The frankli link in the Applications list

  4. Select the Provisioning tab.

    Provisioning tab

  5. Set the Provisioning Mode to Automatic.

    Provisioning tab automatic

  6. Under the Admin Credentials section, input your frankli Tenant URL and Secret Token. Click Test Connection to ensure Microsoft Entra ID can connect to frankli. If the connection fails, ensure your frankli account has Admin permissions and try again.


  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.

    Notification Email

  8. Select Save.

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

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

    Attribute Type Supported for filtering Required by frankliio
    userName String
    active Boolean
    name.givenName String
    name.familyName String
    emails[type eq "work"].value String
    addresses[type eq "work"].formatted String
    addresses[type eq "work"].streetAddress String
    addresses[type eq "work"].locality String
    addresses[type eq "work"].postalCode String
    addresses[type eq "work"].country String
    title String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager 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 frankli, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  13. Define the users and groups that you would like to provision to frankli by choosing the appropriate values in Scope in the Settings section.

    Provisioning Scope

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

    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 complete than next 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 will go into quarantine. Learn more about quarantine states here.

More resources

Next steps