Add a custom Directory Store - Directory Stores | Admin Guide - Zoho Directory

Add a Custom Directory Store

Roles that can perform this action: Organization Owner, Organization Admin
Subscription plans that support this feature: Free trial or any subscription
Other requirements: An active account in the service to add as a custom store, with a role that can generate authorization tokens required for the integration.

This article discusses the steps to add a third-party directory service as a store in Zoho Directory to facilitate user management. Learn more about directory stores

Step 1: Create custom store in Zoho Directory

  1. Log in to Zoho Directory, then click ADMIN PANEL.
  2. Go to DIRECTORY STORES, then click Add Directory.
  3. Click Create Custom Store in the top-right corner.

  4. The Store logo will be auto-generated. Click Change if you wish to choose a different logo or logo color from the available list.
  5. Enter the Integration Name and Description.
  6. Click Next.

  7. The Sync endpoint and SCIM token will be generated and displayed. Copy both of these to your clipboard.


Step 2: Configure integration in the third-party service

  1. In a separate browser tab or window, log in to the third-party service you want to integrate.
  2. Using the Sync Endpoint and the SCIm token copied from your Zoho Directory account, add Zoho Directory as an app in the service. Refer the service documentation to know the exact steps involved.
    Info
    Depending on the service, you may have to add Zoho Directory from the list of pre-integrated apps or as a custom app.
  3. Return to the Zoho Directory configuration window and click Next.

Step 3: Configure Field Mapping

Field mapping ensures proper data transfer from the custom store to Zoho Directory during user import. The Field Mapping section lists the fields available in Zoho Directory against the relevant fields from your custom store. You can choose the mapping value from the following options:
  1. Profile field: These are default fields available in the custom store. Use the drop-down list beside each field to modify the selection.

  2. Hard-coded value: Use this option to apply the same value for all users to import. For example, you can set the Work Location of all selected users to India.
    To do this,
    1. Hover over the field and click Edit.
    2. Select Hardcoded value and enter the value to display. e.g. India.
    3. Click OK.


  3. Expression: This option allows you to construct dynamic values from existing profile fields. For example, you can enter a string to combine the values from First name, followed by their domain name in the format <@domain.com> in the custom store into the Email field in Zoho Directory.
    To do this,
    1. Hover over the field and click Edit.
    2. Select Expression and enter the value. Eg. concat(user.First name, "@domain.com")
    3. Click OK.

  4. Custom Attribute: These are custom fields added in the third-party service.
    To do this,
    1. Hover over the field and click Edit.
    2. Select Custom attribute and enter the field name. e.g. workspace_id
    3. Click OK.

  5. JSON path: Use this option to extract a specific value from a set of values in the third party service. For example, you can define a JSON path to extract the city from the Address field in the third party service to be entered in the Place field in Zoho Directory.
    To do this,
    1. Hover over the field and click Edit.
    2. Select JSON path and enter the value.
    3. Click OK.
Once you have mapped all required fields, click Save and Next.

Step 4: Configure General Settings

Define whether and how to notify users on activities related to the store.
  1. Under Mail Notification, choose if you want to notify users about activities related to this integration via email.
  2. Under Password Notification, define how the users newly added to Zoho Directory during import will gain access. You can choose from one of the options listed below.
    1. Send email OTP to user: Users will receive a one-time password to access the application when logging in the first time, after which they will be forced to set a new password.
    2. Send email OTP to Admin: You can choose one of the admin users to receive a one-time password to activate the user account. The selected admin can communicate this OTP to the user, or reset the password for the user.
    3. Don't notify anyone: Users added during import will not have access to their account unless an admin manually invites them to join the organization. The user must accept the invite to access their account.
      Notes
      The Password Notification section will display only if you select Notify via mail under the Mail Notification section.
  3. Under Status Sync, choose whether changes made to the user status in the custom store should reflect in Zoho Directory.
    If you choose to apply the changes to Zoho Directory, the changes will reflect in the corresponding Zoho Directory user profiles during the next sync schedule.
  4. Once done, click Save and Next.


Step 5: Configure Criteria

You can either sync all users from the custom store, or define a set of users from the store to be synced based on a set of criteria. To set criteria:
  1. Select a criterion from the options, choose a relationship, and enter a value. You can set multiple criteria and apply them in various combinations using AND or OR conditions.
  2. Once done, click Save and Close.


You have now configured a directory service of your choice as a custom directory store in Zoho Directory to facilitate user management.





        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 FormsLegal
                                Mobile App
                                Form DesignerHR
                                Mobile 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 FormsFormstack alternativeEncrypted Forms

                                Wufoo alternativeSecure Forms

                                TypeformWCAG


                                    All-in-one knowledge management and training platform for your employees and customers.

                                              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

                                                                                                                                • Add JumpCloud to Zoho Directory

                                                                                                                                  Prerequisites: Roles required in Zoho Directory: Organization Owner Organization Admin Roles required in JumpCloud: Admin Plan required in Zoho Directory: Free plan Add JumpCloud to Zoho Directory Using API Using SCIM Using API To add JumpCloud as a ...
                                                                                                                                • Add Google Workspace to Zoho Directory

                                                                                                                                  Prerequisites In Zoho Directory: Organization Owner or Admin in Zoho Directory In Google Workspace: User address should be updated in the below given format to ensure successful user import <Street>,<City>,<State>-<Postal/Zip Code>,<Country> You can ...
                                                                                                                                • Add Microsoft Entra ID to Zoho Directory

                                                                                                                                  Prerequisites: Roles required to perform this action : Organization Owner Organization Admin Add Entra ID to Zoho Directory Using API Using SCIM Using API In Microsoft Entra ID: Sign in to Microsoft Entra admin center. In the left panel, click Entra ...
                                                                                                                                • Rename a Directory Store

                                                                                                                                  To rename a directory store: Sign in to Zoho Directory, then click Admin Panel in the left menu. Click Directory Stores, then click the required store. Click Edit under the store name. Modify the name, then click Update. You cannot use the same name ...
                                                                                                                                • Add OneLogin to Zoho Directory

                                                                                                                                  Prerequisites Roles required in Zoho Directory to perform this action: Organization Owner Organization Admin Role required in OneLogin: Admin Plan required in Zoho Directory: Free plan Professional plan (if you want to add multiple directories) In ...
                                                                                                                                  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