Cuir in eagar

Comhroinn trí


Tutorial: Configure Atea for automatic user provisioning

This tutorial describes the steps you need to do in both Atea and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users and groups to Atea using the Microsoft Entra provisioning service. For important details on what this service does, how it works and frequently asked questions refer Automate user provisioning and deprovisioning to SaaS applications with Microsoft Entra ID.

Capabilities supported

  • Create users in Atea
  • Remove users in Atea when they do not require access anymore
  • Keep user attributes synchronized between Microsoft Entra ID and Atea

Prerequisites

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

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

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

Contact Atea support to configure Atea to support provisioning with Microsoft Entra ID.

Add Atea from the Microsoft Entra application gallery to start managing provisioning to Atea. If you have previously setup Atea 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 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 Atea

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

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

    The Atea link in the Applications list

  4. Select the Provisioning tab.

    Provisioning tab

  5. Set the Provisioning Mode to Automatic.

    Provisioning tab automatic

  6. In the Admin Credentials section, select Authorize. It opens an Atea login dialog box in a new browser window.

    Atea authorize

  7. On the Atea's log in dialog, sign in to your Atea's tenant and verify your identity.

    Atea login dialog

  8. Upon completing steps 5 and 6, click Test Connection to ensure Microsoft Entra ID can connect to Atea. If the connection fails, ensure your Atea has Admin permissions and try again.

    Atea test connection

  9. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications. And then select the Send an email notification when a failure occurs check box.

    Notification Email

  10. Select Save.

  11. Under the Mappings section, select Synchronize Microsoft Entra users to Atea.

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

    Attribute Type Supported for filtering Required by LawVu
    userName String
    active Boolean
    emails[type eq "work"].value String
    name.givenName String
    name.familyName String
    name.formatted String
    phoneNumbers[type eq "mobile"].value String
    locale String
  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 Atea, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  15. Define the users and groups that you would like to provision to Atea by choosing the relevant value 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 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.

Change Log

  • 10/25/2022 - Drop core user attribute nickName.
  • 10/25/2022 - Changed the mapping of core user attribute name.formatted to Join(" ", [givenName], [surname]) -> name.formatted.
  • 10/25/2022 - Domain name of all OAuth config urls of Atea app changed to Atea owned domain.

Additional resources

Next steps