The JumpCloud Active Directory Integration (ADI) enables the syncing of users, groups, and passwords between JumpCloud and on-premise or off-premise AD. As covered in Get Started: Active Directory Integration, the ADI uses two agents: an Import Agent and a Sync Agent that can be installed in three (3) configurations which are based on where you want to manage users, groups, and passwords:
- Manage users, groups, and passwords in AD
- Manage users, groups, and passwords in JumpCloud
- Manage users and passwords in either system, or both
This article provides a step-by-step guide for configuring ADI to manage users, security groups, and passwords in AD, JumpCloud, or both. This configuration provides the greatest flexibility. It allows AD and JumpCloud to manage user credentials and attributes together in unison, a full two-way sync. Users are able to change passwords within either AD or JumpCloud. It also supports a hybrid approach where specific information is managed in one system and other information is managed in the other system. This configuration supports:
- Data syncs bidirectionally between JumpCloud and AD
- Passwords managed in either system or both
- Users created, updated, and deactivated in either system or both
- User (security) groups created and managed in either system or both
- Group membership managed in either system or both
Deployment Configuration Overview
- Use both the ADI import agent and ADI sync agent
- Install agents on either domain controllers (DCs) or member servers
To sync passwords from AD to JumpCloud, the import agent must be installed on all DCs.
- Add users and security groups under the ADI security group in AD to sync from AD to JumpCloud
- Assign users and user groups to the ADI AD domain in JumpCloud to sync from JumpCloud to AD
To explore the use cases and benefits of this configuration see Manage users and passwords in either system, or both in the Configure Active Directory Integration (ADI) help center article.
Workflows
Two-way sync – single domain
Two-way sync – multiple domains
To learn more about the general user identity workflow and expected behavior for any user, group, and password change after the AD Import and AD Sync agents have been configured, read Use and Manage the Active Directory Integration (ADI) .
System Requirements
- 64-bit Windows Server (versions 2012, 2016, 2019, 2022)
- Server Core installation is also supported for Windows Server versions 2016, 2019, and 2022. You will need to include the /msiexec parameter when running the agent installer
- 15MB disk space
- 10MB RAM
Installation Steps Overview
The main steps you will take to install and configure AD for bi-directional use are:
- Determine on which servers the AD import agents will be installed: member servers or domain controllers (DCs).
- Complete the prerequisite checklist.
- Determine the Root User container in AD.
- Create the JumpCloud ADI Integration Security Group in AD.
- Create the AD Import Service Account.
- Create the AD Sync Service Account.
- Delegate control for the AD Import and AD Sync Service Accounts.
- Create an AD domain instance in JumpCloud.
- Select your configuration and download the agents.
- Run the the AD Import Agent installation wizard.
- Reboot each AD server where the import agent was installed.
- Verify the Import Agent Service started.
- Complete post-installation AD import agent configuration on each DC.
- Run the AD Sync Agent installation wizard.
- Verify AD sync and AD import agents in the JumpCloud Admin Portal.
Considerations
Agent Version Considerations
Import Agent
When upgrading from AD import agent v2.6.0 or lower, you must select Install New Agent from the Downloads dropdown menu in the ADI Details page to get the connect key, which is required to complete the upgrade of the agent on the AD server.
- Import agent v3.0.0 and higher supports delegated user authentication to AD
- As of import agent v2.2.1, the following changes were made:
- The default location for all agent related installation, configuration, and log files is C:\Program Files\JumpCloud\AD Integration.
- All references to AD Bridge changed to AD Import.
- The jcimport username & password and the API key are stored in the registry instead of the ADI Import Agent configuration file. Both the password and API key are encrypted and the values in the registry are replaced with the encrypted value when the import agent starts.
Sync Agent
- As of ADI sync agent version 4.5.1, the following changes were made:
- The default location for all agent related installation, configuration, and log files is C:\Program Files\JumpCloud\AD Integration\
- The ADI sync agent can be installed independently of the ADI import agent
- The ADI sync agent connect key is encrypted and the value in the registry is replaced with the encrypted value when the agent starts
Delegated Authentication Considerations
The delegated authentication functionality is specific to the ADI AD import agent. Review ADI: Use AD Delegated Authentication for specific considerations and more information about delegated authentication to AD.
When the delegated authentication setting, Delegated Password Validation, is enabled and Pending for the ADI configuration and the user's Delegated Authority is Active Directory, the user will not be able to log in. An AD import agent, version 3.0 or higher, must be installed and active to change the status of Delegated Password Validation from Pending to Active.
When upgrading the AD import agent to version 3.0, existing users connected to the domain will not have their log in delegated to AD unless the Delegated Authority is manually set to Active Directory for those existing users.
- The delegated authentication setting, Delegated Password Validation, is disabled by default but can be enabled.
- When the delegated authentication setting, Delegated Password Validation, is enabled and active:
- All users imported from AD to JumpCloud by import agent v3.0.0 or higher will have their Delegated Authority automatically set to Active Directory and their login to the JumpCloud User Portal and SSO login delegated to AD for validation.
- Existing AD users imported from AD to JumpCloud no longer have to reset their password in AD to log in to JumpCloud managed resources when delegation is enabled for them.
- When the delegated authentication setting, Delegated Password Validation, is disabled:
- All users imported by import agent v3.0.0 or higher will have their Delegated Authority automatically set to Active Directory and their login to the JumpCloud User Portal and SSO login delegated to AD for validation.
- Existing AD users imported from AD to JumpCloud no longer have to reset their password in AD to log in to JumpCloud managed resources when delegation is enabled for them.
General Installation Considerations
All installed agents should be the same version to avoid unexpected behavior or the potential for users not being able to log in if the primary agent is switched.
You must reboot the servers after the AD Import Agent installation.
You DO NOT need to reboot the servers after the AD Sync Agent installation.
- The AD sync agent does not need to be installed on all servers.
- Connect Keys are one-time use keys required for installing the agents on a new AD server. They expire in seven days.
- The AD Domain and Root User container DN must be the same for both the AD import agent and AD sync agent
- Non-standard ASCII characters are not supported in the Root User DN.
- When upgrading an agent, the installation wizard prompts for minimal information:
- Directory for where the installation should occur.
- Finish screen.
- Upgrading from AD import agent v2.6.0 or lower to v3.0.0 or higher will also prompt for the import agent connect key.
- An ADI integration specific Security Group (e.g., “JumpCloud”) must be configured within the root user container or root OU to import and sync users from AD to JumpCloud:
In multi-domain environments, the security group must have a unique name within each domain (e.g., “JumpCloud (mydomain1)” and “JumpCloud (mydomain2)”)
- Demoting a DC installation to a member server and promoting a member server installation to a DC aren’t supported. The agent(s) must be uninstalled first and then installed on the other type of server.
- A reinstall of the same ADI import agent is treated as an update.
- When multiple AD agents are installed, one is designated as the primary agent by the ADI service. All create and change requests are sent to that agent. If that agent becomes unavailable, another active agent is automatically designated as the primary.
- When updating an existing agent installation, only minimal installation screens are shown:
- Directory for where the installation should occur
- Finish screen
Member Server Installation Considerations
The following are considerations only if you choose to install the ADI agents on member servers:
Import Agent
- The AD password does NOT sync from AD to JumpCloud. Users imported and synced from AD will not have a password in JumpCloud.
- A server reboot is required.
Sync Agent
- If you have member servers in your AD environment, installing the sync agent on member servers is the recommended option.
- All sync agent functionality works when the agent is installed on member servers.
- A server reboot is NOT required.
Domain Controller (DC) Installation Considerations
The following are considerations only if you choose to install the agents on DCs:
Import Agent
- Downtime should be scheduled. The installation requires a server reboot.
- An import agent must be installed on all Domain Controllers.
- AD passwords will sync from AD to JumpCloud.
Sync Agent
- A sync agent does NOT need to be installed on all Domain Controllers.
- Installing the sync agent on more than one DC is recommended for redundancy and high-availability .
- The installation does not require a server reboot.
- JumpCloud passwords will sync from JumpCloud to AD.
Security Considerations
- It is STRONGLY recommended to install and use LDAPS for the ADI. Configuring and using LDAPS on the Domain Controller that the Jumpcloud ADI agents will connect to secures any sensitive information that is exchanged between the Jumpcloud agents and the Domain Controller and protects against malicious users
- We recommend periodically rotating the passwords for the server accounts used by the integration e.g., jcimport and jcsync) for security reasons.
- API tokens are specific to each Admin account. Use a separate, dedicated account for this integration to prevent the possibility of breaking the ADI connectivity to your JumpCloud organization when an Admin account is deleted.
If the JumpCloud Administrator Account associated with the import is deleted or the API key is rotated, the import will stop working. All imports will fail until a valid API key is generated and updated in the registry on the AD servers.
Password Considerations
- Password complexity requirements in AD and JumpCloud should be as closely aligned as possible to avoid passwords being rejected and failing to sync due to not meeting the complexity requirements.
- Users imported from AD to JumpCloud will have their Password Authority set to None (JumpCloud). This setting can be changed from Users>More Actions>Set External Password Authority or directly from the User Details page.
- When the JumpCloud AD import agent is installed on member servers, the AD password does NOT sync to JumpCloud.
- This configuration is used when user passwords are managed in JumpCloud.
- Users imported from AD will not have their AD password stored on their initial login to JumpCloud nor will the password sync from AD to JumpCloud.
- Users imported from AD will have
- When a user’s Password Authority is set to None (JumpCloud) the password can set and managed in JumpCloud.
Users will not be able to log in to JumpCloud User Portal or SSO apps if JumpCloud AD import agent is installed on member servers, the user's Password Authority is set to Active Directory, and the user's Delegated Authority is set to None.
- When the JumpCloud AD import agent is installed on all DCs, the AD password does sync from AD to JumpCloud. This means that the password will be saved in both AD and JumpCloud.
- When a user’s Password Authority is set to None (JumpCloud):
- Passwords can be managed in AD, JumpCloud, or both.
- Password expiration notifications are sent from JumpCloud.
- When a user’s Password Authority is set to Active Directory:
- The password cannot be set or changed password in JumpCloud, with the exception of the link from the password expiration notification.
- Passwords must be managed in AD.
- Password expiration notifications are sent from JumpCloud.
- When a user’s Password Authority is set to None (JumpCloud):
User Sync Considerations
- Synced users must have values for <First Name> and <Last Name>, i.e., the first name and last name fields cannot be empty, otherwise the users will fail to sync.
- The JumpCloud ADI import and sync agent services use TLS for all communication. If no network connectivity exists to JumpCloud, the ADI won’t work properly
Sync from AD to JumpCloud
- We recommend that all users you plan to import from AD into JumpCloud live in a single OU or be nested underneath a chosen OU (Root user container) in AD. This can be the default CN=Users container in AD or an alternate custom OU in the directory.
- If you relocate users in AD outside of the Root User Container, you could disrupt password synchronization, or remove users and groups from your JumpCloud instance, along with any associated data and resource associations.
- To sync users from AD to JumpCloud, users must be members of the ADI specific Security Group (e.g., “JumpCloud” or “JumpCloud -Domain1”) or of a Security Group nested under this Security Group
- Users who are imported from AD to JumpCloud will automatically have their Password Authority set to Active Directory by default and the attributes that sync will be read-only in both the Admin Portal and in User Portal. These fields become restrictedFields.
- You can manage users in 2 ways:
- Individually by adding them to the security group created for this integration, located in the designated OU
- Using groups located in or nested in the designated Root user container by adding those groups as a member of the JumpCloud Integration Security Group
- ADI Import Agent settings in the jcadimportagent.config.json file control the behaviors that occur in JumpCloud when certain actions are taken on the user in AD
- Removing users from the JumpCloud integration Security Group within AD will either delete those users in JumpCloud and deprovision them from all bound resources or disconnect them from the AD integration, leaving them active in JumpCloud and allowing them to be managed in JumpCloud directly. The behavior is controlled by the UserDissociationAction setting in AD Import Agent configuration file
- Removing users from the JumpCloud Integration Security Group within AD will either delete those users in JumpCloud and deprovision them from all bound resources or disconnect them from the AD integration, leaving them active in JumpCloud and allowing them to be managed in JumpCloud directly. The behavior is controlled by the UserDissociationAction setting in AD Import Agent configuration file
- Importing privileged user accounts, such as Domain Admins and accounts with “adminCount=1”, into JumpCloud from AD, isn’t supported.
- The Password Authority setting can be changed for a specific user from their user record directly or for multiple users from Users >More Actions>Set External Password Authority.
Export and sync from JumpCloud to AD
- Users created in AD from JumpCloud are created in the AD root container.
Regular
Migrating device accounts from AD Managed to JumpCloud Managed
- JumpCloud has a tool, called the ADMU, which is used to migrate end-user Windows computers from AD to JumpCloud
Attributes
The user attributes that sync from AD to JumpCloud are:
- First Name
- Last Name
- Username
These attributes become read-only (restrictedFields) in JumpCloud when a user's Password Authority is set to Active Directory. The Password Authority setting can be changed for a specific user directly from their User Details page or for multiple users from Users >More Actions>Set External Password Authority.
Prerequisite Checklist
Before installing the AD import and AD sync agents, we recommend completing each of the following checklist items before continuing.
- Know your AD Domain Admin credentials.
- Decide whether you want to install the sync agents on your AD domain’s non-DC Domain Member Servers (member servers) or Domain Controllers (DCs).
- When installing the import agent on DCs, schedule downtime. Installation requires server reboot!
- If installing the AD sync agent on DCs, we recommend that you install the AD Sync agent on your Primary DC and any DC impacted by extended replication delays.
- Verify you have access to all DCs or member servers in the AD domain.
- Ensure your DCs or member servers are running on a JumpCloud supported 64-bit Windows Server version (2012, 2016, 2019, 2022).
- Verify DCs or member servers have networking access to the internet and are able to communicate outbound to console.jumpcoud.com over HTTPS port 443.
- Create a dedicated Administrator account in JumpCloud that is specifically for the ADI.
API tokens are specific to each Admin account. Create a separate, dedicated account for this integration to prevent the possibility of breaking the ADI connectivity to your JumpCloud organization when an Admin account is deleted.
- Generate and securely store the API key for the ADI dedicated Administration account.
- Verify all users to be synced from AD to JumpCloud and JumpCloud to AD have a value for first name and last name.
- Align password complexity requirements between AD and JumpCloud as closely as possible. Otherwise, passwords may not replicate if they’re rejected by the destination directory’s complexity requirements.
- (Recommended) Verify all users you plan to import into JumpCloud live in a single OU or are nested underneath a chosen OU (Root user container) in AD. This can be the default CN=Users container in AD or an alternate custom OU in the directory.
- Review Advanced Configurations for the Active Directory Import Agent to understand the configuration settings available for the import agent and note any default values that need to be changed as part of the installation.
- (Strongly recommended) Install LDAPS.
We strongly recommend installing and using LDAPS for the ADI. Configuring and using LDAPS on the Domain Controller that the Jumpcloud ADI agents will connect to secures any sensitive information that is exchanged between the Jumpcloud agents and the Domain Controller and protects against malicious users.
Prepare AD for the Agent Installations
Determine Root User Container
Prepare for the agent installations in AD by determining the Root User Container.
The AD Domain and Root User container DN needs to be the same for both the AD import agent and AD sync agent.
AD Import Agent
The JumpCloud AD Import agent is designed to integrate with AD’s default ‘Users’ container (CN=Users) which is pre-populated in the AD Users and Computers (ADUC) interface and labeled as “Users” as shown in the following image. (This is a default domain with no custom containers. In this use-case the Root Container is CN=Users;DC=example;DC=com).
The import agent installation wizard assumes that this is the Root User container and uses this path in your AD Import agent configuration file. During installation, you’re prompted for the domain components (DC) used in your AD Domain (i.e., DC=example;DC=com). The installation wizard uses this base level domain information to construct the following Root user container DN (Distinguished Name).
EXAMPLE: CN=Users;DC=example;DC=com
If CN=Users isn’t the Root User Container you want to use in your AD instance, you can update the path in the agent configuration file, jcadimportagent.config.json, after the AD Import agent install completes. This is covered in the Configure AD Import Agent section below
AD Sync Agent
The AD sync agent installation wizard prompts you to enter the Root User Container during the JumpCloud AD sync agent installation.
If you want to use AD’s default Root User container for the JumpCloud AD Integration, the value you will need to enter during the AD sync agent installation is CN=Users;DC=example;DC=com
If AD’s default Root User container (CN=Users) isn’t the Root User Container you want to use for your JumpCloud AD integration, follow the steps below to get the distinguishedName value you will need to enter during the AD sync agent installation. You will need to follow similar steps to update the Root User Container value in the AD import after the AD Import agent install completes.
- Verify the full LDAP path for the chosen Root user container you have selected in ADUC:
- From the ADUC panel’s View menu, enable Advanced Features.
- Right-click the container and select Properties.
- Select the Attribute Editor tab.
- Select the “distinguishedName” attribute, then click View.
- Note the value. It will need to be entered during the AD sync agent installation.
Create the JumpCloud ADI Integration Security Group in AD
A Security Group for the integration must be created within the Root User Container you’ve defined in the previous step. This Security Group is required. Any member of this group will be synced from AD to JumpCloud.
If you do not create this group or give it a unique name across domains, the ADI sync from AD to JumpCloud will fail to function properly.
- Open the ADUC Menu, click the Start button, type “dsa” and click the Active Directory Users and Computers icon.
- Find your Root User Container.
- Right-click the Root User Container’s folder and click New > Group.
- Ensure the Security Group is a Global Security Group.
- Give the Security Group a name that helps identify it as the group used by the ADI (e.g., “JumpCloud” for single domain environments, “JumpCloud (Domain)” for multi-domain environments).
- Click OK.
In multi-domain environments, the security group must have a unique name within each domain (e.g., “JumpCloud (mydomain1)” and “JumpCloud (mydomain2)”).
Create the AD Import Service Account in AD
After you identify the ‘Root user DN’ that you want to use with your JumpCloud integration, you proceed by creating a new AD-based service account (standard user account) that allows the JumpCloud AD import agent to manage users and groups.
- Open the ADUC Menu, click the Start button, type “dsa” and click the Active Directory Users and Computers icon.
- Find your Root User Container.
- Right-click the container and click New > User.
This user cannot:
- Be a Domain Administrator
- Be a member of the JumpCloud integration security group
- Have a username of “JumpCloud”
- Enter the following values for the JumpCloud Import Service Account user:
- First Name: JumpCloud
- Last Name: Import
- User logon name: jcimport
Use jcimport to distinguish what this user is for and to which agent it is attached.
- Enter a password for the jcimport user and ensure that it is set to Never Expire since this will be a service account for the Import Agent.
This password should still be rotated periodically for security reasons.
- Click Save.
Create the AD Sync Service Account in AD
After you identify the Root User Container (‘Root user DN’) that you want to use with your JumpCloud AD integration, create a new AD-based service account (standard user account) that allows the JumpCloud AD sync agent to manage users and groups.
- Open the ADUC Menu, click the Start button, type “dsa” and click the Active Directory Users and Computers icon.
- Find your Root User Container, right-click the container and click New > User.
This user cannot:
- Be a Domain Administrator.
- Have a username of “JumpCloud”.
- Be a member of the JumpCloud security group.
- Enter the following values for the JumpCloud Import Service Account user:
- First Name: JumpCloud
- Last Name: Sync
- User logon name: jcsync
Use jcsync to distinguish what this user is for and to which agent it is attached.
- Click Next
- Enter a password for the jcsync user and ensure that it is set to Never Expire since this will be a service account for the Sync Agent.
This password should still be rotated periodically for security reasons.
- Click Save.
Delegate Control for the AD Import and Sync Service Accounts in AD
If you will be using a Root user container DN other than the ‘Users’ default, you need to do these steps on that chosen container in your AD.
- Navigate to the Root User Container in ADUC that you have selected, right-click the container and select Delegate Control. This launches the Delegation of Control Wizard.
- Click Next.
- Add the newly created service account user to the Delegation of Control Wizard.
- Click Next, then select the following tasks:
- Create, delete, and manage user accounts.
- Reset user passwords and force password change at next logon.
- Read all user information.
- Create, delete, and manage groups.
- Modify the membership of a group.
- Click Next, then click Finish at the final screen.
- Right-click the Root User Container in ADUC again and select Delegate Control.
- Click Next.
- Add the JumpCloud Import Agent account to the Delegation of Control Wizard.
- Click Next, then select Read all user information.
- Click Next, then click Finish at the final screen.
Install the AD Import and Sync Agents
Create an ADI AD Domain in JumpCloud
Create a new ADI domain instance in JumpCloud if one does not already exist.
- Log in to the JumpCloud Admin Portal.
- Go to Directory Integrations > Active Directory.
- Click ( + Add ADI Domain ).
- Select Manage users and passwords in JumpCloud, AD or both.
- Enter the name of an Active Directory domain that you want to integrate with your JumpCloud tenant. For example, “DC=example;DC=com”.
The “DC” must be in capital letters. Each value must be separated with a semicolon (;) not a comma. There should be no spaces. The domain case must be the same as it is in the AD import configuration file.
- Click Save.
- If you want to use delegated authentication, select the checkbox for Delegated Password Validation.
- This option may be useful when importing existing users from AD to JumpCloud. It allows them to log in to the JumpCloud User Portal using their existing AD credentials for the first time.
Download the agents
- Click Download Import Agent.
- The Import Agent installer will automatically save to your local Downloads folder.
- After downloading the agent, note and store the 3 values needed for the agent installation:
- Your JumpCloud Organization ID
- Your Import Agent Connect Key
- The API key for the dedicated admin account for the integration
- Copy and securely store the values.
- If you already generated an API key but didn’t store it, you will need to regenerate it. Regenerating an API key will break any currently installed import agents and all other integrations using that API key. Be cautious with this option. See Rotate the Active Directory Import API Key for more information.
- Click Close.
- Click Download Sync Agent.
- The Sync Agent installer will automatically save to your local Downloads folder.
- The Install Sync Agent modal appears and you will be presented with the AD Sync Agent Installation Connect Key. This is the unique one-time use key that is required to connect the Sync Agent to your JumpCloud Org and this AD domain Integration within JumpCloud. You will input this key during the AD Sync Agent install in the steps below.
- Click Copy and save it to a password manager for later use.
- Click Close.
- Save the downloaded installers to the AD servers.
The Connect Key will expire in 7 days if it is not used.
Run the AD Import Agent Installation Wizard
Now you are ready to install the JumpCloud AD import agent.
If you are installing the AD import agent on your DCs, the AD import agent must be installed on all of the write capable DCs within the domain. This does not apply to Read-Only DCs (RODCs).
If you are installing the AD import agent on non-DC domain member servers, we recommend installing on at least 2 servers.
- Browse to where you saved the AD Import installer file on the server.
- Right-click the file, then select Run as administrator.
- The Install Wizard will start and prompt you to agree to the C++ license terms and conditions.
- Select the type of server on which you are installing the AD import agent:
- If you selected Domain Controller, skip to step 9.
- If you selected Member Server for the server type, provide the FQDN or IP address for that server. We recommend using FQDN.
- Confirm your LDAP connection type and decide if you want to allow the use of LDAP if the connection using secure LDAP fails.
We STRONGLY recommend against allowing the use of LDAP if the connection using secure LDAP fails. LDAP is not secure and increases your potential risk of cyberattacks as it sends unencrypted data. Attackers can spy on the connection and intercept packets sent over the network. We STRONGLY recommend the use of LDAPS only for this integration.
If are installing the AD import agent on a DC and have not or cannot install LDAPS or TLS, you must select the "Allow insecure connection (LDAP) to a Domain Controller if secure connection fails"option. Otherwise, the integration will fail.
- If you checked Allow insecure connection (LDAP) to a Domain Controller, if secure connection fails, you must confirm that you understand the risk before you can proceed.
- Enter the AD Distinguished Name (DN) of the domain and click Next.
The domain name should match the case of the domain name entered in the JumpCloud Admin Portal. For example, example.com should be entered as "DC=example;DC=com".
- Enter the jcimport account and password, then click Next. Be sure to use the NetBIOS domain format and not the full DNS name. (For example, example\jcimport and the user password).
If you’re unsure of the NetBIOS name, right-click the domain name in ADUC and select Properties. Use the value labeled Domain name (pre-Windows 2000).
- Enter the JumpCloud API Key for the dedicated Admin account created for the ADI, then click Next.
- Enter your JumpCloud Organization ID, then click Next.
- On Selecting the File Destination, leave the defaults and click Next.
- Click Install. The import agent will take about 1 to 2 minutes to install.
- Select Yes, restart the computer now and click Finish.
You must reboot your AD servers after the AD Import Agent installation!
Verify the JumpCloud AD Import Agent Service Started
Once your DC restarted, verify that the service started by confirming display name: “JumpCloud AD Integration Import Agent” ; service name: “JCADImportAgent”; is running in services.msc. If the service fails to start, you can review the agent logs at C:\Program Files\JumpCloud\AD Integration\JumpCloud_AD_Import.log
Configure AD Import Agent
There are several configuration options that you should implement post-installation of the AD import agent. The recommended configuration updates are:
- Update LDAPS configuration file
- Modify the Root User Container Used by AD Import
- Update the security group name if your environment has multiple domains
Verify and update default import settings described in Advanced Configurations for AD Import.
To change any of the configuration options, start by opening the AD Import Agent configuration file using a text editor: C:\Program Files\JumpCloud\AD Integration\AD Import\jcadimportagent.config.json.
Modify the Root User Container used by AD Import
The AD Domain and Root User container DN needs to be the same for both the AD import agent and AD sync agent.
If your Root User Container is the default CN=Users;DC=company;DC=com, you can skip this section.
If you’re using a different Root user container for managing AD resources with the AD Import agent, follow the steps below to modify the User container location in the agent configuration json file.
- Verify the full LDAP path for the chosen Root user container you have selected in ADUC:
- From the ADUC panel’s View menu, enable Advanced Features.
- Right-click the container and select Properties.
- Select the Attribute Editor tab.
- Select the “distinguishedName” attribute, then click View.
- In the AD Import Agent configuration file, replace the CN=Users;DC=company;DC=com reference in the LDAP section of the json configuration file with the “distinguishedName” value from ADUC, leaving the CN=JumpCloud security group reference in place. See the example below.
Be sure to place semicolons ( ; ) between the values, e.g., “CN=JumpCloud;OU=Corporate Users;DC=contoso;DC=com”
An example of the configuration file that has been changed from the Defaults to match what’s actually the true Root User Container. In the below example config, Example’s Root User Container needs to be, CN=JumpCloud;OU=Corporate Users;DC=example;DC=com.
You must create or relocate the JumpCloud security group to this Root user container and grant delegated control to the service account for AD Import agent integration. The LDAP values noted in this DN specify the explicit path to the location of the JumpCloud security group in your AD environment.
Modify the Security Group used by AD Import
You will need to update the security group name in the AD import configuration file to match the name you gave the JumpCloud integration Security Group in the Create the JumpCloud ADI Integration Security Group in AD above.
- Update the security group reference in the DN, CN=JumpCloud, to match the name you gave the JumpCloud integration security group.
Modify default Advanced Configuration settings for AD Import
Adjust the default configuration settings to control how the import works and what happens to users in JumpCloud when certain actions are taken in AD. These settings are considered advanced configurations. See Advanced Configurations for AD Import for more information.
Save the configuration changes and restart the AD import agent service
You do not need to restart the DC only restart the service to apply configuration changes.
Once all configuration changes have been made save them and restart the service.
- Save the jcadimportagent.config.json file.
- Restart the JumpCloud AD Import Agent service using the Windows Service Manager.
Run the AD Sync Agent Installation Wizard
Now you are ready to install the JumpCloud Sync Agent on one or more member servers or your Primary DC and any DC within the domain that could experience replication delays.
If you are installing the AD sync agent on DCs, do not install the AD Sync Agent on Read-Only DCs (RODCs).
- Browse to where you saved the AD Integration Sync installer file on your DC.
- Right-click the file, then select Run as administrator.
- Once the Installer Wizard appears, click Next.
- On the Destination Folder screen, click Next.
- Select the type of server on which you are installing the agent, DC or non-DC member server, then click Next.
- If you chose Domain Controller, skip to step 9.
- If you chose Member Server as your server type, enter the information for the DC to which the member server should connect to sync data from JumpCloud to AD. We recommend using the FQDN for your DC.
- Confirm your LDAP connection type and decide if you want to allow the use of LDAP if the connection using secure LDAP fails.
We STRONGLY recommend against allowing the use of LDAP if the connection using secure LDAP fails. LDAP is not secure and increases your potential risk of cyberattacks as it sends unencrypted data. Attackers can spy on the connection and intercept packets sent over the network.
We STRONGLY recommend the use of LDAPS only for this integration.
- If you checked Allow insecure connection (LDAP) to a Domain Controller, if secure connection fails, you must confirm that you understand the risk before you can proceed.
- Enter in the Root User Container you noted in the Determine the Root User Container in AD section above. If you’re using the default AD Root User Container, the value will be CN=Users;DC=company;DC=com. If you’ve chosen another Root User Container, enter the value you noted.
- In this example, we’ve modified the Root User Container. The value is: OU=Corporate Users;DC=example;DC=com
The AD Domain and Root User container DN needs to be the same for both the AD import agent and AD sync agent.
Case is important when entering the User Root DN, always use capital “OU”, “CN”, and “DC”.
- Enter the AD Sync Agent’s Service Account you’ve created. This should be the jcsync User Account you created in the Create the AD Sync Service Account section above. Then click Next.
Case is important when entering the Windows Login Domain, use the same case that was used when creating the AD domain instance in JumpCloud.
- Enter the Connect Key that was presented to you within the JumpCloud Admin Portal after downloading the AD Sync Agent. Then click Next.
- Finally, click the Install button to install the AD Sync Agent. This could take up to 3 minutes.
You DO NOT need to reboot the servers after the AD Sync Agent installation.
Congratulations! You’ve installed the AD Sync Agent. You are ready to verify that the AD Sync Agent is communicating properly.
Verify AD Import and AD Sync
Once you’ve installed the AD import and AD sync agents within your AD environment. You can easily verify that the JumpCloud AD Sync Agent is working. Please ensure the following are present and visible:
- The JumpCloud AD Sync Agent should be shown as green and active within the Admin Portal under Directory Integrations > Active Directory > Domain Integration > Domain Agents tab.
If the AD Sync Agent(s) or the AD Import Agent(s) are showing red or are in a non-connected state, please check services.msc to see if the services are running.
Additionally,
- JumpCloud User Group is now within your JumpCloud organization. The JumpCloud User Group should have a User Group icon with an AD badge in the User Group Details pane. See the example below:
- Navigate to User Management > User Groups. You should see the JumpCloud User Group with a Microsoft badge next to it. Click on the User Group to open up its details
- When opened, you can see that the User Group has a Microsoft Badge and is also assigned to AD on the Directories tab.
Next Steps
Please read the Using and Managing the ADI article next.
Want additional assistance from JumpCloud?
If you’re having issues with getting JumpCloud’s ADI working, try the Troubleshooting Guide. JumpCloud now offers myriad professional services offerings to assist customers with implementing and configuring JumpCloud. If you’re looking for assistance with Migrating from AD, or to integrate AD with JumpCloud, we recommend you reach out to JumpCloud’s Professional Services team on the following page: Professional Services - JumpCloud.