Muokkaa

Jaa

Tutorial: Configure Templafy SAML2 for automatic user provisioning

  • Artikkeli

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

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

  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 Templafy SAML2.

Assigning users to Templafy SAML2

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 SAML2. Once decided, you can assign these users and/or groups to Templafy SAML2 by following the instructions here:

Important tips for assigning users to Templafy SAML2

  • It's recommended that a single Microsoft Entra user is assigned to Templafy SAML2 to test the automatic user provisioning configuration. More users and/or groups may be assigned later.

  • When assigning a user to Templafy SAML2, 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 SAML2 to support provisioning with Microsoft Entra ID

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

  1. Sign in to your Templafy Admin Console. Click on Administration.

    Templafy Admin Console

  2. Click on Authentication Method.

    Screenshot of the Templafy administration section with the Authentication method option called out.

  3. Copy the SCIM Api-key value. This value is entered in the Secret Token field in the Provisioning tab of your Templafy SAML2 application.

    A screenshot of the S C I M A P I key.

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

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

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

Step 4: Configure automatic user provisioning to Templafy SAML2

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 SAML2 based on user and/or group assignments in Microsoft Entra ID.

Tip

You may also choose to enable SAML-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 complement each other.

To configure automatic user provisioning for Templafy SAML2 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 Templafy SAML2.

    The Templafy SAML2 link in the Applications list

  4. Select the Provisioning tab.

    Screenshot of the Manage options with the Provisioning option called out.

  5. Set the Provisioning Mode to Automatic.

    Screenshot of the Provisioning Mode dropdown list with the Automatic option called out.

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

    Tenant URL + Token

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

    Notification Email

  8. Click Save.

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

  10. Review the user attributes that are synchronized from Microsoft Entra ID to Templafy SAML2 in the Attribute Mappings section. The attributes selected as Matching properties are used to match the user accounts in Templafy SAML2 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.

  11. Under the Mappings section, select Synchronize Microsoft Entra groups to Templafy.

  12. Review the group attributes that are synchronized from Microsoft Entra ID to Templafy SAML2 in the Attribute Mappings section. The attributes selected as Matching properties are used to match the groups in Templafy SAML2 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.

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

  14. To enable the Microsoft Entra provisioning service for Templafy SAML2, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  15. Define the users and/or groups that you would like to provision to Templafy SAML2 by choosing the desired values in Scope in the Settings section.

    Provisioning Scope

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

    Saving Provisioning Configuration

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

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 goes into quarantine. Learn more about quarantine states here.

Change log

  • 05/04/2023 - Added support for Schema Discovery.

More resources

Next steps