• Overview
  • Configuration

Related-apps

Yodeck

Manage Yodeck display users effortlessly with secure directory synchronization.

Identity provisioningCollaboration & communication

Overview

Integrating Yodeck with ManageEngine ADManager Plus enables IT teams to streamline user management by automating identity and access management tasks. This integration allows IT teams to synchronize user records in Active Directory (AD) to Yodeck and reduce manual effort, enhance security, and maintain accurate user data. This integration ensures seamless user creation and updates in Yodeck, driven by real-time changes in AD.

 

Automate user creation

Automatically set up user accounts in Yodeck based on records from AD. This keeps user access aligned with your organization’s policies and eliminates the need for manual user creation.

 

Automate user updates

Synchronize updates to user records in Yodeck based on changes made to user accounts in AD. For example, if a user’s details are modified in AD, the corresponding updates are automatically reflected in Yodeck , ensuring data consistency.

 

How to configure Yodeck integration in ADManager Plus

Prerequisites:

Yodeck uses Custom API token for Authorization. Refer to the Yodeck's 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 Yodeck(outbound action): Ensure the account used for authorization has permission to perform the desired action.
Note: ADManager Plus comes with a preconfigured 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 the API documentation to configure under the inbound/outbound webhooks to perform the required actions.

Authorization configuration

  • Log in to ADManager Plus and navigate to Directory/Application Settings.
  • Go to Application Integrations, then search and select Yodeck.
  • Toggle the Enable Yodeck Integration button on.
  • Replace **** with Token value in all the authorization's header value of all URLs.
  • Click Configure.

Inbound webhook configuration

Inbound webhook enables you to fetch user data from and transfer it to ADManager Plus. To configure an inbound webhook for :

  • Under Inbound Webhook, click Endpoint Configuration.
  • In the Endpoint Configuration tab, an endpoint, LIST USERS ENDPOINT, comes preconfigured with an Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from. If you would like to use this preconfigured endpoint, replace **** with the token value 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 Yodeck's API references. Click here to learn how. Note:
    • The API key value pair is preconfigured as a header for authenticating API requests as structured during Authorization Configuration.
    • You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component.
    • Refer to Yodeck's API references and configure additional headers and parameters, if required.
  • Once done, click Test & Save. A response window will display all the requested parameters that can be fetched using the API call. After verifying if the requested parameters have been called to action, click Proceed. Note:
    • Refer to Yodeck's API references to know the Parameters that must be configured to fetch only specific parameters.
    • You can configure multiple endpoints for Yodeck 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 Yodeck.
  • 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 (for example, 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 attribute in Yodeck.
    • If you would like to create a new custom format for this, click Add New Format.
    • Click Save.
Note: The attribute mapping configured in this section can be selected as the data source during automation configuration to perform the desired action on the list of users received from the API response.

Outbound webhook configuration

An outbound webhook enables you to send changes made in AD using ADManager Plus to and carry out tasks in —all from ADManager Plus. To configure an outbound webhook for Yodeck:

  • Under Outbound Webhook, click 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 Yodeck's API references for the API details, such as the URL, headers, parameters, and other requirements.
  • 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 on which to test the configured API call. Select the desired user or group on 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 according to the configuration.
  • The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.
Note: The webhooks configured in this section can be included in Orchestration Templates, which can be used in event-driven and scheduled automations. They can also be applied directly to desired users to perform a sequence of actions on them (under Management > Advanced Management > Orchestration).