Edit

Share via

Tutorial: Configure Workgrid for automatic user provisioning

  • Article

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

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 Workgrid tenant
  • A user account in Workgrid with Admin permissions.

Assigning users to Workgrid

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

Important tips for assigning users to Workgrid

  • It is recommended that a single Microsoft Entra user is assigned to Workgrid to test the automatic user provisioning configuration. Additional users and/or groups may be assigned later.

  • When assigning a user to Workgrid, you must select any valid application-specific role (if available) in the assignment dialog. Users with the Default Access role are excluded from provisioning.

Set up Workgrid for provisioning

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

  1. Log in into Workgrid. Navigate to Users > User Provisioning.

    Screenshot of the Workgrid U I with the Users and User Provisioning options called out.

  2. Under Account Management API, click Create Credentials.

    Screenshot of the Account Management A P I section with the Create Credentials option called out.

  3. Copy the SCIM Endpoint and Access Token values. These will be entered in the Tenant URL and Secret Token field in the Provisioning tab of your Workgrid application.

    Screenshot of the Account Management A P I section with S C I M Endpoint and Access Token called out.

Add Workgrid from the gallery

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

To add Workgrid 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 Workgrid, select Workgrid in the search box.
  4. Select Workgrid from results panel and then add the app. Wait a few seconds while the app is added to your tenant. Workgrid in the results list

Configuring automatic user provisioning to Workgrid

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

Tip

You may also choose to enable SAML-based single sign-on for Workgrid , following the instructions provided in the Workgrid 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 Workgrid 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 Workgrid.

    The Workgrid 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 the SCIM Endpoint and Access Token values retrieved earlier in Tenant URL and Secret Token respectively. Click Test Connection to ensure Microsoft Entra ID can connect to Workgrid. If the connection fails, ensure your Workgrid 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 Workgrid.

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

    Attribute Type Supported for filtering Required by Workgrid
    userName String ✓ ✓
    active Boolean
    displayName String
    title String
    emails[type eq "work"].value 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
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager String
    addresses[type eq "work"].locality String
    addresses[type eq "work"].postalCode String
    addresses[type eq "work"].formatted String
    addresses[type eq "work"].region String
    addresses[type eq "work"].streetAddress String

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

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

    Attribute Type Supported for filtering Required by Workgrid
    displayName String ✓ ✓
    externalId String ✓
    members Reference

  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 Workgrid, 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 Workgrid by choosing the desired values in Scope in the Settings section.

    Provisioning Scope

  16. When you are 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. For more information on how long it will take for users and/or groups to provision, see How long will it take to provision users.

You can use the Current Status section to monitor progress and follow links to your provisioning activity report, which describes all actions performed by the Microsoft Entra provisioning service on Workgrid. For more information, see Check the status of user provisioning. To read the Microsoft Entra provisioning logs, see Reporting on automatic user account provisioning.

Additional resources

Next steps