Azure Active Directory Driver 5.2.1.0000 Readme

The Azure Active Directory Driver also referred to as Azure AD Driver in this document, allows you to seamlessly provision and deprovision users, group memberships, exchange mailboxes, roles, Teams, Channels, SKU and licenses to Azure AD Cloud. You can also configure the driver to integrate with OpenText™ Identity Manager Service for Exchange Online (Identity Manager Exchange Service) for synchronizing Office 365 attributes.

What's New?

• Added support for OpenSSL 3.0.15 and TLS 1.3.

This Readme comprises the following sections:

• Overview
• System Requirements
• Upgrading the Driver
• Technical Support Information

Overview

This update is applicable for OpenText Identity Manager Driver for Office 365 and Azure Active Directory running OpenText Identity Manager 4.10. The driver version will be changed to 5.2.1.0000 after the patch is applied.

• Microsoft has announced the retirement of Azure AD and Msol PowerShell modules. MS has recommended using Microsoft graph based PowerShell cmdlets instead.For more information refer to: Upgrade from Azure AD PowerShell to Microsoft Graph PowerShell
• It is highly recommended to perform the Driver Upgrade by taking downtime so that there no changes in Azure are lost while the driver is getting upgraded. Otherwise, after the upgrade, it will be necessary to migrate the Users and Groups into OpenText Identity Vault to ensure that no changes in Azure were lost.
• From October 1st 2023 the Exchange services of Azure AD driver 5.1.7 may not work as expected because RPS will be disabled by Microsoft, for reference Deprecation of Remote PowerShell in Exchange Online. Hence this update is mandatory to ensure the driver continues to work normal.

System Requirements

• OpenText Identity Manager 4.10.
• OpenText Identity Manager Designer 4.9.
• REST Driver 1.3.0.0100.
• .NET Framework 4.8 or later. For more details on server compatibility, see Install .NET Framework on Windows and Windows Server.

Prerequisites

Run the following commands before upgrading the driver to install the requirments:

• Install-Module -Name ExchangeOnlineManagement -RequiredVersion 3.3.0
• Install-Module -Name Microsoft.Graph -RequiredVersion 2.4.0

Upgrading the Driver

The driver upgrade process involves the following tasks:

Upgrading the Driver Files

1. Take a back-up of the current driver configuration.


2. (Conditional) If the driver is running locally, stop the driver instance and the OpenText Identity Vault.


3. (Conditional) If the driver is running with a Remote Loader instance, stop the driver and the Remote Loader instance.


4. Download and unzip the contents of the IDM_AzureAD_5.2.1.zip file to a temporary location on your computer.


5. (Conditional) To upgrade the driver files:


• As a root user, perform the following steps:


1. On the server where you want apply the driver patch, log in as root.


2. Navigate to the extracted <IDM_AzureAD_5.2.1.zip> directory and perform one of the following actions for your platform:


• Linux:


• Navigate to the <IDM_AzureAD_5.2.1.zip>;/Linux directory
• Install the netiq-DXMLRESTAzure.rpm by running the following commands in a terminal window:

rpm -Uvh (patch-path)/linux/netiq-DXMLRESTAzure.rpm



• Windows:


• Navigate to the <extracted IDM_AzureAD_5.2.1.zip>/Windows folder. Copy and replace the AZDriverShim.jar, RestLib.jar, and OData.jar. files in the C:\NetIQ\IDM\NDS\lib folder.


• Upgrade the Windows Exchange Service:


• Stop the IDMExchangeOnline service from Windows services console (services.msc).


• Navigate to Windows Exchange Service in the extracted <IDM_AzureAD_5.2.1.zip> folder and copy the Microsoft.Identity.Client.dll, ExchServerHost.exe and IDMExchServer.dll files to the Windows Exchange Service installation folder in your file system. For example, C:\NetIQ\ExchangeServerHost.


• Create new Certificate for Identity Manager Exchange Service. Refer to Securing Communication with Identity Manager Exchange Service
• Run configureExchService.bat with appropriate parameters as mentioned below.
• if you wish to continue using Basic Authentication , use the command - configureExchService.bat 9001 exchcba 0 as an examlpe.
• if you wish to use Certificate Based Authentication (which is recommended), use the command - configureExchService.bat 9001 exchcba 5 as an example.
• Start the IDMExchangeOnline service from Windows services console(services.msc).

Important: To support new APIs, you must mandatorily install the Microsoft Exchange Online PowerShell V3 module (EXO V3). For the prerequisites and installation procedure, see About the Exchange Online PowerShell V3 module.

To support Microsoft Graph CMDLETS you need to install Microsoft Graph PowerShell SDK. Refer to Powershell CMDLET 5.1.7 Configurations



6. As a non-root user, perform the following steps:


1. Verify that /rpm directory exists and contains _db.* file.

The _db.* file is created during a non-root installation of the OpenText Identity Manager engine. The absence of this file might indicate that the Identity Manager is not installed properly. You must reinstall the OpenText Identity Manager to correctly place the file in the directory.

2. To set the root directory to the location of non-root OpenText Identity Vault, enter the following command in the command prompt:

ROOTDIR=<non-root eDirectory location>

This will set the environmental variables to the directory where OpenText Identity Vault is installed as a non-root user.

3. To install the driver files, enter the following command:

For example, to install the REST driver RPM, use this command:

rpm --dbpath $ROOTDIR/rpm -Uvh --relocate=/usr=$ROOTDIR/opt/novell/eDirectory --relocate=/etc=$ROOTDIR/etc --relocate=/opt/novell/eDirectory=$ROOTDIR/opt/novell/eDirectory --relocate=/opt/novell/dirxml=$ROOTDIR/opt/novell/dirxml --relocate=/var=$ROOTDIR/var --badreloc --nodeps --replacefiles /home/user/netiq-DXMLRESTAzure.rpm

where /opt/novell/eDirectory is the location where non-root eDirectory is installed and /home/user/ is the home directory of the non-root user.

7. (Conditional) If the driver is running locally, start the OpenText Identity Vault and the driver instance.


8. (Conditional) If the driver is running with a Remote Loader instance, start the Remote Loader instance and the driver instance.

Technical Support Information

Issues Fixed in Previous Release (5.2.0.0200)

• Defect 641011 - IDM - Azure Driver Start -> Fatal "The DriverShim is out of sync with the Exchange Service" when short date is not configured as MM/DD/YYYY..
• Defect 641012 - Regarding 'LicenceOptionStatus' Issue on M365 Driver.
• Defect 649090 - Publisher synchronization delays of several hours / days