Setting up Microsoft Entra ID synchronization

To enable Microsoft Entra ID authentication with SAML 2.0 Single sign-on (SSO), synchronization must be enabled. Edit values in the common.properties file and the identity_providers.properties file to enable synchronization.

About this task

To perform the basic configuration for Microsoft Entra ID authentication, complete the following steps:

Procedure

  1. Click Admin > Edit properties file.
  2. Ensuring that you are editing the common.properties file, edit the following properties
    sync.entraID

    Synchronizes the users and groups from Microsoft Entra ID with the Remote Control database. Takes the values true, to synchronize or false, for no synchronization.

    True

    Microsoft Entra ID is synchronized with the Remote Control database to reflect any changes that are made.

    False

    No synchronization takes place. If synchronization is disabled, you must manually import the users into the Remote Control database. Otherwise, they cannot log on to the Remote Control server. The users must exist in the Remote Control database so that they can be associated with the relevant permissions that are required to establish remote control sessions.

    Note:

    Only one synchronization task can be enabled at the same time; if this property is enabled together with the LDAP synchronization (sync.LDAP), then only the LDAP synchronization task will be executed. The synchronization is performed by running a scheduled task. The task automatically deletes all users and groups data while starting so before running it is recommended to perform a backup. The task also pulls the Microsoft Entra ID information and updates the database with any changes that are made to the user or group information. Within the trc.properties file, two attributes define the time interval that the scheduler uses to check for scheduled tasks.

    scheduled.interval
    The frequency that the server must check for scheduled tasks. The number of units of time between each checking period. Default is 60.
    Note:
    If you change this value, restart the server service for the new value to take effect.
    sync.entraID.task_run_time
    Use to indicate the time of the day the a fixed time synchronization has to occur. This is an alternate setting to scheduled.interval. Possible values: 24 hours notation of the time in HH:MM:SS. For Example 02:00:00 to perform the synchronization at 2 AM.
    Note:
    • When using using sync.entraID.task_run_time the actual task execution time is affected by the scheduled.interval setting, as the Microsoft Entra ID synchronization occurs within the context of the task scheduler. The actual execution time can span from sync.entraID.task_run_time to sync.entraID.task_run_time + scheduled.interval.
    • The server must be restarted to use fixed time synchronization.
    scheduled.interval.period
    The unit of time to be used along with the scheduled interval to specify how often the server must check for scheduled tasks. Default is minutes. The scheduled.interval attribute is set to 60 as default and the scheduled.interval.period set to minutes, that is, the server checks for and runs any scheduled tasks every 60 minutes. To accurately reflect any changes to the users or groups, set the scheduled.interval attribute to a lower value so that the synchronization can occur more frequently.
  3. Click Submit.