Advanced Configuration Guide for ADI
After your initial Active Directory (AD) configuration, you can customize your sync with additional options to meet your organization's needs. For more information, see the sections below. For information about the basic Active Directory Integration (ADI) installation and configuration process, see our Active Directory Integration (ADI) Configuration Guide.
Creating an ADI Service Account in Active Directory
To set up ADI, you must use or create an account in AD that has the following permissions:
- read all user information
- read all inetOrgPerson information
To create an AD User with necessary read permissions, follow the steps below:
- Open Active Directory Users and Computers.
Right-click on your domain and select Delegate Control. When you select Delegate Control, the Delegation of Control modal will open.
In the Delegation of Control modal, add your previously created ADI Service account.
- Delegate the Read all user information task and the Read all inetOrgPerson task.
- Lastly, you will need to reconfigure your ADI sync service to use your new AD service account with ADI.
To change the specified user, follow the steps below:
- Navigate to your C:\Program Files (x86)\KnowBe4\ADIsync\ folder and delete the <domain>.dat file.
- Open the command prompt as an administrator and navigate to your \ADIsync folder, then type “ADIsync.exe config”.
Changing Where to Pull Email Addresses from in Active Directory
By default, the ADI sync will sync all proxy email addresses for your users. However, you can change where you would like to pull email addresses from in Active Directory. Additionally, you can choose to only sync users’ primary proxy email addresses. Open your ADISync.conf file from within your C:\Program Files\KnowBe4\ADISync folder. By default, you will see the following fields:
- emailAttribute = "proxyAddresses"
- primaryproxyonly = false
For more information about changing which email addresses sync for your users, see the list below:
- Primary Proxy Only: If you would like to only use the primary proxy address for each user, change the primaryproxyonly field from "false" to "true". Save the ADIsync.conf file, then start the ADI service again. This process will ensure that no alias email addresses are synced.
- Mail Attribute: If you would like the sync to use the Mail attribute instead of proxyAddresses, change the emailAttribute field to "mail" from "proxyAddresses" and the useMailAttrib field to "true" instead of "false". Save the ADIsync.conf file and start the ADI service again.
Important: Regardless of which field you are syncing by, the mail attribute for a user cannot be empty. For the purposes of ADI, this value does not need to be a valid domain. For more information, contact our support team.
- User Principal Name: If you would like the sync to use the userPrincipalName (UPN) instead of proxyAddresses, change the emailAttribute field from "proxyAddresses" to "userPrincipalName". Save the ADIsync.conf file and start the ADI service again.
Viewing Mail and Proxy Addresses in Active Directory
Follow the steps below to view a user’s mail and proxy address in Active Directory. You can also use these steps to view a user’s PrincipalName.
- In the Active Directory Users and Computers window, click View from the toolbar.
From the View drop-down menu, select Advanced Features.
- Double-click on a user to open the User Properties pop-up window.
- In the User Properties pop-up window, select the Attribute Editor tab.
To view the user's mail address, search the Attribute column for mail. Select mail, then click the Edit button.
When you click Edit, the String Attribute Editor pop-up window will open. From this pop-up window, you can adjust the Value of the mail attribute.
To view the user's proxy address, search the Attribute column for proxyAddresses. Select mail, then click the Edit button.
When you click the Edit button, the Multi-valued String Editor pop-up window will open. Here, you can add or remove a Value to the proxyAddresses attribute.
Support for Multiple Domain Sources
If your users are split between multiple domain sources, you will need to set up a configuration for each domain with user objects that need to be synchronized.
For each additional domain, you will need to run the ADIsync.exe config in your ADI sync installation directory. Running the ADI sync configuration a second time will create the additional <your domain here>.conf files that should be edited in order to specify the filter criteria for your sync.
To run ADI sync configuration for multiple source domain support, follow the steps below:
- Open the command prompt in administrator mode.
- Navigate to the \ADIsync system directory. The system directory's default location is C:\Program Files (x86)\KnowBe4\ADISync.
- Type adisync.exe config and press the Enter key.
- Enter the details for your additional domain controller and domain. For more details, see step 7 in the Installation and Configuration section of our Active Directory Integration (ADI) Configuration Guide.
- Once the additional <your domain here>.conf file has been created, edit the file to specify the information that you would like to sync. For more details, see our Active Directory Integration (ADI) Configuration Guide.
- Save the <your domain here>.conf file. After repeating this process for all of your additional domains, you can start your synchronization.
Installing the Newest Version of ADI
Follow the steps below to install the newest version of ADI without uninstalling your previous version:
- Download the new installer from your KMSAT Account Settings.
- Run the installation.
- Close the DOS prompt that appears at the close of installation.
- Start the sync service.
Your users should continue to sync as expected.
Syncing Custom Fields
The user profiles in your KnowBe4 console include custom fields (click to view example) that you can use to sync additional information from your Active Directory. To specify the information that you want to sync to the custom fields, edit the <your domain here>.conf file and then start the service again for your changes to sync. To learn more, see Syncing Other User Information to KnowBe4.