Integrate Your Directory with Zoho Directory Identity Connect | Sync Users from LDAP

Integrate Your Directory with Zoho Directory Identity Connect

Download and install the Identity Connect Agent on a machine that meets the following requirements:
  1. Supported platforms: 64-bit Windows Server 2008 or later / Windows 10 or later
  2. LDAP user credentials with read access to your directory
  3. The agent must be installed on a machine within the same network as your LDAP server (preferably a Domain Controller)
  1. Download the Agent
    1. Sign in to Zoho One. Click Admin Panel from the left menu.
    2. Go to the Directory Stores tab. Click Add Directory.
    3. Find Active Directory and click Add.
    4. In the Download Agent screen:
      1. Review the prerequisites.
      2. Copy the Installation Key displayed there.
      3. Click Download Agent and wait for the download to complete.
  2. Install the Agent
    1. Execute the downloaded file ZohoDirectory_LDAPConnect.msi to start installation.
    2. Paste the Installation Key. Upon successful validation, you'll be taken automatically to the setup wizard where you can complete the rest of the installation steps.
    3. On the Welcome screen, choose your language.
    4. Read the software license agreement carefully and then accept the terms (mandatory). Click Continue.
      Notes
      Note: Clicking the URL doesn't auto-redirect you to the page in some legacy systems, so click 🔗 to copy the URL and then paste it in your browser to read up.
    5. Open the provided Login URL from a browser.
    6. Sign in to your Zoho One admin account if you haven't already.
    7. Enter the Verification Code shown in the installer.
    8. Upon successfully signing in, a confirmation screen with your Zoho account email and display name appears. Click Continue.
      Possible error cases that appear at this step:
      Error 
      Fix
      The verification code is time-bound and will become invalid after the expiry time (5 minutes)
      Click Retry to generate a new code, using which you can sign in and proceed to configuring your LDAP settings.
      Sometimes, the agent may not be able to contact the Zoho server due to network issue.
      Click Retry. If the error persists, write to support@zohodirectory.com

  3. Configure Sync in Zoho One
    Once the agent is installed, complete the sync setup in Zoho One.
    1. Configure LDAP Connection Details
      This is a crucial step where the agent is allowed to connect with Active Directory to fetch data of users and groups for sync.
      1. Enter your directory info: Domain Name, Domain Controllers, User's Distinguished Name (DN), Password. Make sure they're all valid.
      2. Enable SSL for a secure connection:
        1. SSL is recommended, as it safeguards sensitive directory data during transmission.
        2. To use SSL:
          1. Your Domain Controller must have a valid SSL certificate issued to its domain.
          2. Also, you must use the fully qualified domain name (FQDN) in the field dedicated for entering DC names (e.g., ldap-server-1.zylker.com). Using only the hostname will cause SSL failure.
      3. Click Next to review the LDAP configurations. If you face the error LDAP server goes unreachable, click Retry to attempt the connection again and also make sure that there's no connectivity issue between the agent machine and LDAP server.
    2. Complete Installation
      1. Click Install to finish setting up the agent. Once finished, the agent will start running in the background as a tray app. Find the agent icon We were unable to process some of the images.  in your system tray.
      2. From the tray app, you can:
        1. Change ownership - Switch the Zoho One admin account linked to the agent in case the original admin leaves your organization or loses LDAP access.
        2. Change LDAP settings - Modify your LDAP server details here. After making changes, click Update to save them.
      3. Go back to the Zoho One Admin Panel to complete the remaining set-up.
    3. Configure Sync Options
      1. Select Organizational Units (OUs)
        1. From the Admin Panel, navigate to Active Directory.
        2. Choose which OUs you want to sync to Zoho One.
        3. Select object types to include:
          1. ➤ Users
          2. ➤ Groups
          3. ➤ Security Groups
          4. ➤ Custom LDAP Query - Enter a valid LDAP query and click Save to sync based on specific LDAP attributes.
        4. Review the picked OUs:
          1. Edit or remove any of those existing OU preferences.
          2. To add more OUs, click Add OUs.
          3. When done, click Add and Continue.
      2. Map Zoho One fields with your LDAP fields
        This is important for making sure user data is correctly transferred.
        1. Toggle between User Mapping and Group Mapping.
        2. Fields will be auto-suggested, but you can manually map them.
        3. Use the tabs to filter by All Fields, Mapped, or Unmapped fields. For example, you can map the Zoho One "Last name" field to your LDAP "Surname" attribute.
        4. For custom attributes:
          1. Click Edit next to one of the default attributes displayed.
          2. Select Custom AD attribute.
          3. Enter a name for the attribute and save it.
      3. Define Sync Criteria
        On the SET SYNC CRITERIA screen, specify which users or groups should be included in the sync.Switch to the Groups tab if needed.
        1. Select import type: Based on criteria / All users
        2. If using criteria: Define Field, Relationship, and Value. Click Save and Next.
    4. Configure Sync Settings
      1. Password Sync Agent (Separate installation)
        The main Identity Connect Agent, when coupled with your Active Directory details, allows you to deploy multiple Password Sync Agents (one per DC) to instantly capture any password change made on these DCs and securely sync those changes to Zoho One. To enable:
        1. Enable the toggle to sync the user passwords securely from Active Directory to Zoho One.
        2. Domain Name is auto-filled based on the info you entered for the Identity Connect Agent installation.
        3. Now, select the DCs where password sync is needed and make sure all of them meet the exclusive requirements to house this agent.
        4. Select if you want to auto-restart the DCs after installation. Regardless of this choice, the password sync agent takes effect only after a DC restart.
          Notes
          Note: If installation fails, the installer will only display Installation failed. Most usual causes are when one or more of the prerequisites are not available: The provided account doesn't have LDAP admin rights (and/or) WinRM is not enabled on the DC.
      2. User Sync Settings
        Configure automated rules for user account handling based on changes in Active Directory.

        Setting

        What it is for

        Options

        Password Notifications

        Decide how new users get their initial passwords

        Send email OTP to user - The new user will receive an email directly to their registered email address containing an OTP.

        Send email OTP to admin - Admin will receive the OTP or setup info, which they should then forward to the user manually.

        Don't notify - No automatic notifications are sent. An admin should manually notify the user and provide them with their login credentials through some other medium on their own.

        Status Sync

        Choose how to reflect a user's AD account status changes in Zoho One.

        Reflect - If disabled in AD, Zoho One account also gets disabled (and re-enabled if restored).

        Do nothing -Ignore AD status changes.

        NotesIf Do nothing is selected, the system will not manage user status anymore. The When User Leaves Selected OU setting will be disabled and unavailable, as it requires Status Sync to be enabled. Learn more about this interactive behaviour illustrated after the table.

        Mail Notifications

        Choose whether you want to send notifications to synced users.

        Send - Sends emails to newly synced users and resend invite links to pending users.

        Don't send - No mail notifications are sent to users.

        When User Leaves Selected OU

        Define what should happen in Zoho One when a user is moved out of a selected/synced AD OU.

        Disable - The user's Zoho account is auto-disabled.

        Do nothing - The user's Zoho account remains active but will no longer be included in the future sync operations.


        Important note: 
        There's this crucial interaction between Setting 2 & Setting 4. The When User Leaves Selected OU setting depends on Status Sync. The former is only available if the latter is set to Reflect in Zoho One. If you choose to Ignore status changes, the system cannot manage user status based on OU membership. Therefore, Setting 4 will be disabled altogether.
        Let's assume there's a user named Dexter in AD and let's see how he's affected during sync with these two settings:

        Status Sync

        When User Move Out of Selected OU

        Action done on user (in AD)

        Result (in Zoho One)

        Reflect in Zoho One

        Disable in Zoho One

        Dexter is removed from OU but still active in AD

        Dexter's Zoho account is disabled (OU rule applies)

        Do nothing

        (field gets disabled with Do nothing selected)

        Dexter is removed from OU

        Dexter's Zoho account remains active but is no longer synced (because Status Sync setting is ignoring status changes, and OU-based handling is off)


      3. Schedule Sync
        Set frequency (Daily/Weekly/Monthly) and time of sync. Click Save and Next.
      4. Review and Finalize Sync
        1. Review and select users from the imported list to add to Zoho One. This screen helps you with filters:
          1. New Users - Users found in your directory but not yet in Zoho One.
          2. Users to Update - Existing Zoho One users whose info will be updated from your directory in the next sync.
          3. Marked for Activation/Disable - Users who will be activated or disabled based on their status in your directory. Pay attention to this category of users before syncing in order to avoid unintended modifications to their access levels.
          4. Ignored - Users who do not meet the defined sync criteria.
        2. Click Add and Continue.
        3. Review the summary and click Finish to complete the set-up. Once installed on multiple DCs, the Password Sync Agents work together under the same Identity Connect configuration, keeping all password updates in sync without extra manual steps.
At this point, you're through with the Identity Connect setup. The system will now automatically sync your AD users and groups to Zoho One based on the rules you have defined.Besides, you get to view the detailed status of both the Identity Connect Agent and the Password Sync Agent in the following formats:
Identity Connect Agent
Domain controller(s): The DCs the agent is configured to sync with.
Agent version: The current version of the agent.
Device name: The name of the machine where the agent is installed.
Status: Connected / Disconnected.
Last sync: The timestamp of the last successful sync.

Password Sync Agent
This section lists each Domain Controller and its password sync status. All agents listed here belong to the same Identity Connect set-up, making it easier to monitor multiple DCs from one place.
Status: Connected / Disconnected. Restart the DCs that are "Disconnected"
Installation status: Installation initiated / Installation complete / Installation failed / Uninstallation initiated / Uninstallation complete / Uninstallation failed.


      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure Forms

                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now






                                                        You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                            Manage your brands on social media


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                Zoho Sheet Resources

                                                                 

                                                                    Zoho Forms Resources


                                                                      Secure your business
                                                                      communication with Zoho Mail


                                                                      Mail on the move with
                                                                      Zoho Mail mobile application

                                                                        Stay on top of your schedule
                                                                        at all times


                                                                        Carry your calendar with you
                                                                        Anytime, anywhere




                                                                              Zoho Sign Resources

                                                                                Sign, Paperless!

                                                                                Sign and send business documents on the go!

                                                                                Get Started Now




                                                                                        Zoho TeamInbox Resources





                                                                                                  Zoho DataPrep Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • Related Articles

                                                                                                                        • Sync from Active Directory/LDAP server

                                                                                                                          Note: Before you install the Zoho One sync tool, ensure that you meet the system requirements. Sign in to Zoho One , then click Directory in the left menu. Go to Directory Stores. Under Active Directory, click Add. Click Download. Install the ...
                                                                                                                        • Directory Stores - Overview

                                                                                                                          What is Directory Stores? If you are using other directory services and finding it difficult to manage all your users there, you can delegate few users/apps and manage them from Zoho One. To use Directory Stores, you will have to perform the ...
                                                                                                                        • Add JumpCloud to Zoho One

                                                                                                                          Prerequisites: Roles required in Zoho One: Organization Owner Organization Admin Roles required in JumpCloud: Admin Plan dependency in Zoho One: Free plan Using SCIM Using API Using SCIM In Zoho One: Sign in to Zoho One , then click Directory in the ...
                                                                                                                        • Zoho One Sync Tool - Overview

                                                                                                                          Zoho One Sync Tool performs a one-way synchronization from your existing LDAP server to the Zoho One Admin Panel. This enables you to maintain all your user identities in a single place, without having to add, edit, or disable user accounts manually ...
                                                                                                                        • Add Okta to Zoho One

                                                                                                                          Prerequisites: Roles required in Zoho One to perform this action: Organization Owner Organization Admin Custom authentication with Okta Roles required in Okta: Admin Plan required in Zoho One: Free plan Professional plan (if you want to add multiple ...
                                                                                                                          Wherever you are is as good as
                                                                                                                          your workplace

                                                                                                                            Resources

                                                                                                                            Videos

                                                                                                                            Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                            eBooks

                                                                                                                            Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                            Webinars

                                                                                                                            Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                            CRM Tips

                                                                                                                            Make the most of Zoho CRM with these useful tips.



                                                                                                                              Zoho Show Resources