• Overview
  • Configuration

Zoho Mail

Enhance workforce management with secure Zoho Mail onboarding and offboarding

Identity provisioning

Zoho Mail is a secure, ad-free, enterprise-ready business email suite that enables better communication within your organization. ADManger Plus - Zoho mail integrations syncs Zoho Mail with your Active Directory, ensuring that every new employee is equipped with a Zoho Mail account promptly upon onboarding. By enabling new employees to collaborate and access crucial information from day one, this integration facilitates immediate and efficient communication within the organization. Furthermore, it ensures secure account closure upon offboarding, resulting in optimized workforce management practices.

 

Swift email setup on onboarding

Initiate email account creation for new hires, ensuring they receive the necessary accesses to fulfill their job responsibilities. This fosters seamless collaboration from day one and minimizing administrative burden.

 

Effortless user offboarding

Promptly revoke Zoho Mail access for departing employees, ensuring a secure and seamless transition during their exit from the organization.

 

Configuration document: Integrating Zoho Mail with ADManager Plus

Prerequisites:

Please ensure to provide the client_id and client_secret to retrieve desired information and perform tasks in Zoho Mail. Refer to Zoho Mail API references for more details.

Privileges:

  • To import users (Inbound action): Ensure the account used for authorization has permission to read all user accounts.
  • To perform any action or query in Zoho Mail (Outbound Action): Ensure the account used for authorization has permission to perform the desired action.
Note: ADManager Plus comes with pre-configured set of APIs that helps perform basic actions with the integration. If the action you require is not available, please gather the necessary API details from Zoho Mail API documentation to configure under inbound/ outbound webhooks to perform the required actions.

Authorization configuration

  • Log in to ADManager Plus and navigate to the Automation tab.
  • In the left pane, under Configuration, click Application Integrations.
  • Under Enterprise Applications, click Zoho Mail.
  • Toggle the Enable Zoho Mail Integration button on.
  • In the Zoho Mail Configuration page, click Authorization.
  • Perform steps to generate client_id and client_secret from Zoho Mail, and paste them in the respective value fields.
  • Click Configure.

Inbound webhook configuration

Inbound webhook enables you to fetch user data from Zoho Mail to ADManager Plus. The attribute mapping configured in this section can be selected as the data source during automation configuration to

To configure an inbound webhook for Zoho Mail:

  • Under Inbound Webhook, click Zoho Mail Endpoint Configuration.
  • In the Endpoint Configuration tab, an endpoint, Zoho Mail USERS ENDPOINT, comes pre-configured with an Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from Zoho Mail. If you would like to use this pre-configured endpoint, replace {subdomain} with the domain name of your Zoho Mail instance in the Endpoint URL field. However, if you would like to use a new endpoint to import users, you can configure one using the + Add API endpoint button and filling in the required fields as per Zoho Mail's API references. Click here to learn how.
  • Note:

    • The API key value pair is pre-configured as a header for authenticating API requests as configured during Authorization Configuration.
    • Macros: You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component.
    • Refer to Zoho Mail's API references and configure additional headers and parameters, if required.
    • In the Settings tab, the Repeat Calling This Endpoint option has been enabled by default to repeatedly call the API until you get all the required data. The Repeat Call Configuration has been pre-configured to increase the page parameter value by 1 to fetch 100 objects in each API endpoint call. In the Repeat Call Criteria field, the condition has been pre-configured to repeat the API call until the response has no values.
  • Once done, click Test & Save. A response window will display all the requested parameters that can be fetched using the API call. Click Proceed.
  • Note:

    • Refer to Zoho Mail's API references to know the Parameters that must be configured to fecth only specific parameters.
    • You can configure multiple endpoints for SurveyMonkey using the + Add API endpoint button. Click here to learn how.
  • Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in Zoho Mail.
  • Click + Add New Configuration and perform the following:
    • Enter the Configuration Name and Description and select the Automation Category from the drop-down menu.
    • In the Select Endpoint field, select the desired endpoint and a Primary Key that is unique to a user (e.g. employeeIdentifier).
    • Note: When multiple endpoints are configured, this attribute must hold the same value in all the endpoints.
    • In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it with the respective column in Zoho Mail.
    • If you would like to create a new custom format for this, click Add New Format.
    • Click Save.

Outbound webhook configuration

Outbound webhook enables you to send changes made in AD to Zoho Mail, fetch data from Zoho Mail, and carry out tasks in Zoho Mail from ADManager Plus. The webhooks configured in this section can be included in Orchestration Templates, which in turn can be used during event-driven and scheduled automations. They can also be applied directly to desired users to perform a sequence of actions on them (Management > Advanced Management > Orchestration).

To configure outbound webhooks for Zoho Mail:

  • Under Outbound Webhook, click Zoho Mail Webhook Configuration.
  • Click + Add Webhook.
  • Enter a name and description for this webhook.
  • Decide on the action that has to be performed and refer to Zoho Mail's API references for the API details, such as URL, and the headers, parameters, and other requirements that will be needed.
  • Select the HTTP method that will enable you to perform the desired action on the endpoint from the drop-down menu.
  • Enter the endpoint URL.
  • Configure the Headers, Parameters, and Message Type in the appropriate format based on the API call that you would like to perform.
  • Click Test and Save.
  • A pop up window will then display a list of AD users and groups to test the configured API call. Select the desired user or group over which this API request has to be tested and click OK. This will make a real time call to the endpoint URL and the selected objects' will be modified as per the configuration.
  • The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.