Add JumpCloud to Zoho Directory | Admin Guide - Zoho Directory

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 store in Zoho Directory using API integration, generate the API key from your JumpCloud administrator account. In Zoho Directory, add the JumpCloud Directory Store and use the API key to authenticate the integration.

In JumpCloud: Generate your API key

  1. Sign in to the JumpCloud Admin Console.
  2. Click Settings in the left menu.
  3. Click Administrators, then click the name of the admin who will be performing this integration.
  4. In the Edit Administrator pop-up, below the Role field, select Enable API access.
  5. Click Save.
  6. Click the User Profile icon in the top-right corner, and then click My API Key.
  7. In the API Key pop-up, click Generate New API Key and note down the API key. You will need it later during Zoho Directory configuration.
    If any error message is thrown instead of the API Key pop-up, refresh the screen once and repeat the 6th and 7th step.
Notes
API key will be displayed only during the time of generation. To view or copy the API key again, repeat the 7th and 8th steps.

In Zoho Directory: Add and configure the directory store

  1. Sign in to Zoho Directory , then click Admin Panel in the left menu.
  2. Go to Directory Stores, then click Add Directory.
  3. Click Add next to JumpCloud.
  4. Under API INTEGRATION, paste the API key copied from Jumpcloud.
  5. Click Next.
  6. Map the fields available in Zoho Directory to the fields available in JumpCloud. If you'd like all users synced from JumpCloud to have the same value for a field, map that field with a hard-coded value. For example, if you want the value for the field 'Country' to be 'India', then you can type India as a value for the Hard-coded Value.
    To map a hard-coded value with a field:
    a. Hover near the relevant field and click Edit.
    b. Enter the value you need in the Hard-coded Value field.

    c. Click OK.
    To map a custom attribute field created in JumpCloud to a field in Zoho Directory:
    a. Hover near the relevant field and click Edit.
    b. Enter the required Attribute Name in the Custom JumpCloud Attribute field.
    c. Click OK.
    Notes
    In JumpCloud, Attribute Name is displayed under the Custom Attributes section of the user details page.
  7. Click Next.
  8. Under SETTINGS, choose your preferences for Password Notification, Status Sync, Sync Criteria, and Scheduled Sync.
    Notes
    Password Notification setting is only applicable to users' whose email address has a verified domain name.
  9. Click Save and Close.
Using SCIM
To add JumpCloud as a store in Zoho Directory using SCIM integration, you must add the JumpCloud store in Zoho Directory and note down the Sync Endpoint and SCIM token. Using these tokens, configure identity management in JumpCloud and authorize the integration to complete the configuration.

In Zoho Directory: Generate auth tokens

  1. Sign in to Zoho Directory , then click Admin Panel in the left menu.

  1. Go to Directory Stores, then click Add Directory.

  1. Click Add next to JumpCloud.

  1. Under API INTEGRATION, note down the Sync endpoint and SCIM token. Later, you'll need to provide this information in JumpCloud to enable sync.


  2. Click Next.

  1. Map the fields available in Zoho Directory to the fields available in JumpCloud. If you'd like all users synced from JumpCloud to have the same value for a field, map that field with a hard-coded value. For example, if you want the value for the field 'Country' to be 'India', then you can type India as a value for the Hard-coded Value.
    To map a hard-coded value with a field:

    1. Click Edit next to a field.

    1. Enter the value you need in the Hard-coded Value field.

    1. Click Ok.

  1. Click Next.

  1. Under SETTINGS, choose your preferences for Password Notification, Status Sync, Sync Criteria, and Scheduled Sync. 

    Notes
    Password Notification setting is only applicable to users' whose email address has a verified domain name.


  2. Click     Save and Close.


In JumpCloud: Configure custom app and test the connection

  1. Sign in to the JumpCloud Admin Console.

 

  1. Select SSO Applications in the left menu.

  1. Click Add New Application.

  1. Select Custom Application.


  1. Click Next. Select the following features:

    • Manage Single Sign-On(SSO)

    • Import users from this app (Identity Management)

    • Export users to this app (Identity Management)

     to enable Identity Management (and SSO, if you want), then click Next.

  1. Enter general info listed on the page, and click Save Application.

  1. Click Configure Application. You can set up SSO here, if you want.

  1. For provisioning, navigate to Identity Management tab.

            

  1. In the Base URL field, paste the Sync endpoint copied from Zoho Directory, and in the Token Key field, enter the SCIM token that you generated in Zoho Directory.

  1. For Test User Email, enter any dummy user email or email domain that is not a part of Zoho Directory.

  1. Once done, click Test Connection. Ensure the Enable management of User Groups and Group membership in this application checkbox is selected.

  1. Click Activate.

  1. Navigate to User Groups tab and select the checkbox next to each user group you want to sync to Zoho Directory. 

    Notes
    JumpCloud syncs only groups of users and not individual users; hence, only the users present under the selected group will be synced to Zoho Directory.

  1. Click Save. 

    Notes
    The sync will take place immediately in Zoho Directory side.

  1. Once done, navigate to the Members tab in JumpCloud on Zoho Directory side to view all of the users synced with Zoho Directory.

                  
Notes
In case of attribute mappings in JumpCloud side, if you want to sync a few information, say, for example, Location, Employee ID, and Job Title, you'll have to manually add each attribute to get it reflected on Zoho Directory side.