Tutorial: Configure Templafy OpenID Connect for automatic user provisioning

Article
10/23/2023

The objective of this tutorial is to demonstrate the steps to be performed in Templafy OpenID Connect and Microsoft Entra ID to configure Microsoft Entra ID to automatically provision and de-provision users and/or groups to Templafy OpenID Connect.

Note

This tutorial describes a connector built on top of the Microsoft Entra user 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.

Prerequisites

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

A Microsoft Entra tenant.
A Templafy tenant.
A user account in Templafy with Admin permissions.

Step 1: Plan your provisioning deployment

Learn about how the provisioning service works.
Determine who will be in scope for provisioning.
Determine what data to map between Microsoft Entra ID and Templafy OpenID Connect.

Assigning users to Templafy OpenID Connect

Microsoft Entra ID uses a concept called assignments to determine which users should receive access to selected apps. In the context of automatic user provisioning, only the users and/or groups that have been assigned to an application in Microsoft Entra ID are synchronized.

Before configuring and enabling automatic user provisioning, you should decide which users and/or groups in Microsoft Entra ID need access to Templafy OpenID Connect. Once decided, you can assign these users and/or groups to Templafy OpenID Connect by following the instructions here:

Assign a user or group to an enterprise app

Important tips for assigning users to Templafy OpenID Connect

It is recommended that a single Microsoft Entra user is assigned to Templafy OpenID Connect to test the automatic user provisioning configuration. More users and/or groups may be assigned later.
When assigning a user to Templafy OpenID Connect, you must select any valid application-specific role (if available) in the assignment dialog. Users with the Default Access role are excluded from provisioning.

Step 2: Configure Templafy OpenID Connect to support provisioning with Microsoft Entra ID

Before configuring Templafy OpenID Connect for automatic user provisioning with Microsoft Entra ID, you will need to enable SCIM provisioning on Templafy OpenID Connect.

Sign in to your Templafy Admin Console. Click on Administration.
Click on Authentication Method.
Copy the SCIM Api-key value. This value will be entered in the Secret Token field in the Provisioning tab of your Templafy OpenID Connect application.

Step 3: Add Templafy OpenID Connect from the gallery

To configure Templafy OpenID Connect for automatic user provisioning with Microsoft Entra ID, you need to add Templafy OpenID Connect from the Microsoft Entra application gallery to your list of managed SaaS applications.

To add Templafy OpenID Connect from the Microsoft Entra application gallery, perform the following steps:

Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
Browse to Identity > Applications > Enterprise applications > New application.
In the Add from the gallery section, type Templafy OpenID Connect, select Templafy OpenID Connect in the search box.
Select Templafy OpenID Connect from results panel and then add the app. Wait a few seconds while the app is added to your tenant.

Step 4: Configure automatic user provisioning to Templafy OpenID Connect

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

Tip

You may also choose to enable OpenID connect-based single sign-on for Templafy, following the instructions provided in the Templafy Single sign-on tutorial. Single sign-on can be configured independently of automatic user provisioning, though these two features compliment each other.

To configure automatic user provisioning for Templafy OpenID Connect in Microsoft Entra ID:

Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
Browse to Identity > Applications > Enterprise applications
In the applications list, select Templafy OpenID Connect.
Select the Provisioning tab.
Set the Provisioning Mode to Automatic.
Under the Admin Credentials section, input https://scim.templafy.com/scim in Tenant URL. Input the SCIM API-key value retrieved earlier in Secret Token. Click Test Connection to ensure Microsoft Entra ID can connect to Templafy. If the connection fails, ensure your Templafy account has Admin permissions and try again.
In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and check the checkbox - Send an email notification when a failure occurs.
Click Save.
Under the Mappings section, select Synchronize Microsoft Entra users to Templafy OpenID Connect.

Review the user attributes that are synchronized from Microsoft Entra ID to Templafy OpenID Connect in the Attribute Mapping section. The attributes selected as Matching properties are used to match the user accounts in Templafy OpenID Connect for update operations. Select the Save button to commit any changes.

Attribute	Type	Supported for filtering
userName	String	✓
active	Boolean
displayName	String
title	String
preferredLanguage	String
name.givenName	String
name.familyName	String
phoneNumbers[type eq "work"].value	String
phoneNumbers[type eq "mobile"].value	String
phoneNumbers[type eq "fax"].value	String
externalId	String
addresses[type eq "work"].locality	String
addresses[type eq "work"].postalCode	String
addresses[type eq "work"].region	String
addresses[type eq "work"].streetAddress	String
addresses[type eq "work"].country	String
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department	String
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization	String

Note

Schema Discovery feature is enabled for this application.

Under the Mappings section, select Synchronize Microsoft Entra groups to Templafy.
Review the group attributes that are synchronized from Microsoft Entra ID to Templafy OpenID Connect in the Attribute Mapping section. The attributes selected as Matching properties are used to match the groups in Templafy OpenID Connect for update operations. Select the Save button to commit any changes.

Attribute Type Supported for filtering

displayName String ✓

members Reference

externalId String

Note

Schema Discovery feature is enabled for this application.
To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
To enable the Microsoft Entra provisioning service for Templafy OpenID Connect, change the Provisioning Status to On in the Settings section.
Define the users and/or groups that you would like to provision to Templafy OpenID Connect by choosing the desired values in Scope in the Settings section.
When you are ready to provision, click Save.

This operation starts the initial synchronization of all users and/or groups defined in Scope in the Settings section. The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the Microsoft Entra provisioning service is running. You can use the Synchronization Details section to monitor progress and follow links to provisioning activity report, which describes all actions performed by the Microsoft Entra provisioning service on Templafy OpenID Connect.

Attribute	Type	Supported for filtering
displayName	String	✓
members	Reference
externalId	String

Step 5: 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 is 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.