Azure Active Directory Driver 5.1.5.0100 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, SKU and licenses to Azure AD Cloud. You can also configure the driver to integrate with Identity Manager Service for Exchange Online (Identity Manager Exchange Service) for synchronizing Office 365 attributes.
This Readme comprises the following sections:
Overview
This update is applicable for an Identity Manager Driver for Office 365 and Azure Active Directory running Identity Manager 4.8.x. The driver version will be changed to 5.1.5.0100 after the patch is applied.
What's New?
- The driver no longer uses the Azure AD Graph API. It now fully utilizes the Microsoft Graph API.
- Added 'Certificate Based Authentication' as another type of Authentication. For more information, refer to: Certificate Based Authentication
- Support for SKU Entitlement
Note: 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 Identity Vault to ensure that no changes in Azure were lost.
System Requirements
- Identity Manager 4.8.4 or later
- Identity Manager Designer 4.8.4 or later
- REST Driver 1.1.2.0300 or later
Upgrading the Driver
The driver upgrade process involves the following tasks:
To upgrade the driver packages, refer to: Upgrading the Driver Packages
To upgrade the driver files, refer to: Upgrading the Driver Files
To set the delegated and application permissions, refer to:Azure AD Directory Configuration Changes - refer to Step3 in the implementation Guide
To set up SSL between the driver and Azure AD graph REST endpoints, refer to: Secured Communication with Microsoft Graph
To set up SSL between the driver and Identity Manager Exchange Service, refer to: Securing Communication with Identity Manager Exchange Service
To clear the DirXML-DriverStorage Attribute , refer to : Post Upgrade Tasks
Upgrading the Driver Packages
- Download and unzip the contents of the IDM_AzureAD_5.1.5_P1.zip file to a temporary location on your computer.
- Open the project containing the driver.
- Import the following packages into Designer from the Packages folder :
Name |
Package Name | Version | Build Date | Build Number |
Azure AD Base |
MFAZUREBASE |
1.0.4 |
20220223 |
175830 |
Cloud Only Entitlements Implementation for the Azure AD Driver |
MFAZUREENTL |
1.0.3 |
20220209 |
133258 |
Default Package for Azure AD and Office 365 Driver |
MFAZUREDCFG |
1.1.3 |
20220218 |
223221 |
Azure AD Hybrid Entitlements |
MFAZURELENTL |
1.0.3 |
20220215 |
195849 |
Note: For importing the packages into Designer, refer to Importing packages into Designer.
- Right-click the driver for which you want to upgrade an installed package, then click Driver > Properties.
- Click Packages.
NOTE: A check mark indicates a newer version of a package in the Upgrades column.
- Click Select Operation for the package that indicates there is an upgrade available.
- From the drop-down list, click Upgrade.
- Select the version that you want to upgrade to, then click OK.
NOTE: Designer lists all versions available for upgrade.
- Click Apply.
- (Conditional) Fill in the fields with appropriate information to upgrade the package, then click Next.
Depending on which package you selected to upgrade, you must fill in the required information to upgrade the package.
- Read the summary of the packages that will be installed, then click Finish.
- Review the upgraded package, then click OK to close the Package Management page.
Note: After you update the Driver Packages you will get Authentication Type options. Based on your choice refer to: Authentication Types
Upgrading the Driver Files
- Take a back-up of the current driver configuration.
- (Conditional) If the driver is running locally, stop the driver instance and the Identity Vault.
- (Conditional) If the driver is running with a Remote Loader instance, stop the driver and the Remote Loader instance.
- Download and unzip the contents of the IDM_AzureAD_5.1.5_P1.zip file to a temporary location on your computer.
- (Conditional) To upgrade the driver files:
- As a root user, perform the following steps:
- On the server where you want apply the driver patch, log in as root.
- Navigate to the extracted <IDM_AzureAD_5.1.5_P1.zip> directory and perform one of the following actions for your platform:
- Windows:
- Navigate to the <extracted IDM_AzureAD_5.1.5_P1.zip>/Windows folder.
Copy and replace the AZDriverShim.jar, RestLib.jar, and OData.jar. files in the C:\NetIQ\IDM\NDS\lib folder.
- Copy the following jar files from IDM_AzureAD_5.1.5_P1/common/ folder and place it in the driver installation folder. For example, \NetIQ\IdentityManager\NDS (local installation) or \Novell\RemoteLoader\64bit (remote installation).
- asm-1.0.2.jar
- common-2.45.4.jar
- content-type-2.2.jar
- json-smart-2.4.7.jar
- msal4j-1.11.0.jar
- nimbus-jose-jwt-9.15.2.jar
- oauth2-oidc-sdk-9.20.1.jar
- slf4j-log4j12-1.7.32.jar
- 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.1.5_P1.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.
- Start the IDMExchangeOnline service from Windows services console(services.msc).
Important: To support new APIs, you must mandatorily install the Microsoft Exchange Online PowerShell V2 module (EXO V2). For the prerequisites and installation procedure, see
About the Exchange Online PowerShell V2 module.
- As a non-root user, perform the following steps:
- Verify that /rpm directory exists and contains _db.* file.
The _db.* file is created during a non-root installation of the Identity Manager engine. The absence of this file might indicate that the Identity Manager is not installed properly. You must reinstall the Identity Manager to correctly place the file in the directory.
- To set the root directory to the location of non-root 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 Identity Vault is installed as a non-root user.
- 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.
- (Conditional) If the driver is running locally, start the Identity Vault and the driver instance.
- (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 this Release (5.1.5.0100)
- Defect 572006 - Azure AD driver not starting - java.lang.illegalArgumentException: Could not parse the as Edmx document
Issues Fixed in Previous Release(5.1.5)
- Defect 327056 - Azure Ad Driver: Unable to assign a license to a user using parent SKU (E1,E3,E5,P1)