This comprehensive blog post will guide you through the process of configuring the IBM Verify Identity Governance (IVIG) Azure AD Adapter service within IBM Security Identity Manager (ISIM) or IBM Verify Identity Governance (IVIG), covering everything from prerequisites to connection testing.
Before we begin, make sure you have the following prerequisites:
The configuration process involves the following steps:
-
Create an app in the Azure Portal and grant basic permissions
-
Download and configure certificates in IBM Security Directory Integrator
-
Add external jars to the patch folder
-
Add the connector jar to the connector folder
-
Restart the Dispatcher service
-
Import the service profile in ISIM/IVIG
-
Create a service and perform Test Connection
Step-by-Step Instructions
Let’s dive into each step in more detail.
Obtaining Domain Name
-
Sign in to the Microsoft Entra ID (formerly Azure Active Directory) Portal.
-
Select Microsoft Entra ID from the menu.
-
The Microsoft Entra ID Overview page appears. To find the Microsoft Entra primary domain name, look for Primary Domain in the Basic information section.
Create an App in Azure Portal
To create an app in Azure Portal, follow these steps:
-
Login: Go to the Microsoft Entra ID (formerly Azure Active Directory) Portal
-
Search for App Registration: Find "App Registration" in the Azure Portal
-
Create a New Registration: Click "New registration" in the App Application tab
-
Register the App: Provide an application name, account type, and register
App Creation Result:
Your app will be created with an Application (Client) Id.
Add Permissions to the App
To add permissions:
-
Go to Overview > API Permissions tab and click Add Permissions.
-
Select Microsoft APIs > Microsoft Graph.
-
Add Delegate or Application Permissions as required.
-
Grant Admin consent for added permissions if necessary
Least Permissions required to perform Basic Operations on the adapter are below:
- Delegated permission - Microsoft Graph
-
- Directory.AccessAsUser.All
- Directory.Read.All
- Directory.ReadWrite.All
- GroupMember.Read.All
- Group.Read.All
- Group.ReadWrite.All
- User.Read
- User.Read.All
- User.ReadBasic.All
- User.ReadWrite.
- All Application permission - Microsoft Graph
-
- Directory.Read.All
- Directory.ReadWrite.All
- User.Read.All
- User.ReadWrite.All
Permissions Note:
Permissions are bound to the attribute of the user you want to read/add/update. Refer to the Azure Active Directory Adapter Release Notes and Azure Graph API documentation for detailed information.
Add Certificates & Secrets
To add certificates and secrets:
-
Go to Overview > Certificates & Secrets.
-
Select New Client Secret.
-
Insert Description and Expiry Duration and click Add.
-
Copy the Secret Value for use in configuring Application Key the Azure Adapter service.
Download and Configure Certificates in IBM Security Directory Integrator
Step 1: Download Certificates
Step 2: Import Certificates
You can import certificates using either iKeyMan (for Windows) or a command in Linux.
Using iKeyMan (Windows)
-
Navigate to <SDI_HOME>/jvm/jre/bin.
-
Start ikeyman.exe.
-
Open the key database file: testadmin.jks (located in <SDI_HOME>/timsol/serverapi).
-
Enter the password (default is administrator).
-
Click Signer Certificates and then Add.
-
Browse to select the downloaded certificates and click OK.
Using Command (Linux)
- Run the following commands:
$SDI_HOME/jvm/jre/bin/keytool -importcert -alias DigiCertGlobalRootG2 -file <PATH_TO_DOWNLOADED_CERT>/DigiCertGlobalRootG2.crt -keystore SDI_HOME/timsol/serverapi/testadmin.jks
$SDI_HOME/jvm/jre/bin/keytool -importcert -alias DigiCertGlobalRootCA -file <PATH_TO_DOWNLOADED_CERT>/DigiCertGlobalRootCA.crt -keystore SDI_HOME/timsol/serverapi/testadmin.jks
- Enter the password when prompted (default is administrator)
Enabling TLS 1.2 in IBM Security Directory Integrator
To enforce the use of TLS 1.1 and TLS 1.2 protocols in the SDI Server, modify the <SOLUTION_DIRECTORY>/solution.properties file by adding the following lines at the bottom:
com.ibm.di.SSLProtocols=TLSv1.1,TLSv1.2
com.ibm.di.SSLServerProtocols=TLSv1.1,TLSv1.2
com.ibm.jsse2.overrideDefaultProtocol=TLSv12
com.ibm.jsse2.overrideDefaultTLS=true
Add External Jars to Patch Folder
To add the required JAR files:
-
Locate the JAR files: Refer to the Azure Active Directory Adapter Release Notes for the download link and supported version for the following JAR files:
-
commons-logging-1.x.jar
-
httpclient-4.x.x.jar
-
httpcore-4.x.x.jar
-
Copy to patch folder: Copy these files to the <SDI_HOME>\jars\patches directory.
-
Verify version consistency: Ensure that no other JAR files with different versions exist in any other JAR folder.
Add Connector Jars to Connector Folder
Extract Downloaded Adapter Package zip and copy the Microsoft365Connector.jar file from to the <SDI_HOME>/jars/connectors directory.
Restart the Dispatcher service
Windows
-
Open the Control Panel and click on Administrative Tools.
-
In the Administrative Tools window, select Services.
-
In the Services window, locate the Dispatcher service.
-
You can start or stop the Dispatcher service as needed.
The service name will either be IBM Security Directory Integrator or the name provided during the installation of the Dispatcher.
Linux
-
Navigate to the timsol directory.
-
Run below command.
./ITIMAd restart
Import Service Profile in ISIM/IVIG
-
Log on to the Identity server by using an account that has the authority to perform administrative tasks.
-
Select Configure System > Manage Service Types
-
Click Import.
-
On the Import Service Type page, perform these steps:
- In the Service Definition File field, click Browse to locate the AzureProfile.jar file.
- Click OK to import the file.
Create Service and Perform Test Connection
Create a service and provide the required details.
-
From the Identity server, click Manage Services.
-
On the Select a Service page, click Create.
-
On the Select the Type of Service page.
-
Adapter Details page, contains multiple tabs, you can do the following tasks (Below information is only for required fields, you can provide information based on your requirements):
-
Azure Details : Provide Service Name, Security Directory Integrator Location.
-
Azure Tenant Domain Details: Provide Azure Tenant Domain name, Application Id and Application Key.
-
Optional: On the Service Information or General Information page, click Test Connection to validate that the data in the fields is correct.
-
Click Next and Finish.
By following these steps, you can successfully configure the IVIG Azure AD/Office365 Adapter service in ISIM and test the connection with on-premises SDI and ISIM.
Troubleshooting Errors
If you encounter any errors, refer to the Error and Resolution section for troubleshooting steps.
We hope this step-by-step guide has helped you configure the ISVG Azure AD/Office365 Adapter service in ISIM successfully. If you have any further questions or concerns, feel free to ask in the comments below!