Objective  

This article explains how to set up a seamless UKG Active Directory integration using ManageEngine ADManager Plus to automate user identity life cycle management. By connecting UKG Pro with Active Directory, IT teams can eliminate manual account provisioning and ensure real-time reflection of HR updates across IT systems.

This HCM integration helps bridge the gap between HR and IT by enabling:

• Ensure real-time data synchronization: Employee updates in UKG Pro—such as role changes or personal info—are automatically reflected in Active Directory, Exchange, Microsoft 365, and other systems.

• Automate user onboarding and offboarding: Employee profiles in UKG Pro trigger automated provisioning and deprovisioning workflows in AD, ensuring seamless, secure account management.

• Improved IT productivity: Reduce manual intervention, provide resource access for new hires, and automate permission updates based on HR records.

Powered by secure API integration, this HR system integration enhances the overall efficiency of your Active Directory integration and aligns IT operations with your organization's HCM workflows.

Prerequisites 

• UKG Pro requires a valid customer API key and user API Key of a web service account.

• 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 UKG Pro (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 UKG Pro API documentation to configure inbound or outbound webhooks to perform the required actions.

Steps to follow 

 Step 1: Authorization configuration 

1. Log in to ADManager Plus and navigate to Directory/Application Settings.

2. Go to Application Integrations, then search and select UKGPro CUSTOM.

3. Toggle the Enable UKGPro CUSTOM Integration button on.

4. In the UKGPro CUSTOM Configuration page, click Authorization.

5. Enter the UKG Pro service account's Username and Password.

6. Click Configure.

 Step 2: Inbound webhook configuration  

Inbound webhook enables you to fetch user data from UKG Pro to ADManager Plus. 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. To configure an inbound webhook for UKG Pro:

1. Under Inbound Webhook, click UKGPro CUSTOM Endpoint Configuration.

2. In the Endpoint Configuration tab, an endpoint, Person Details Endpoint and Employment Details Endpoint comes preconfigured with an endpoint URL, API method, Headers, and Parameters fields to fetch user accounts from UKG Pro. To use this preconfigured endpoint, replace {Ultipro_webservice_URL} with the web service URL of your UKG Pro instance and {customer_api_key} with the customer API key available on the UKG Pro settings page in the US-Customer-Api-Key field. 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 UKG Pro's API references. Click here to learn how.

Note:

• The API key value pair is preconfigured as a header for authenticating API requests during the Authorization configuration process.

• You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component. Click here for more details.

• Refer to UKG Pro's API references and configure additional headers and parameters, if required.
  

3. Configure parameters to retrieve only the required set of users based on dateTimeChanged or dateTimeCreated. For example, add the parameter dateTimeChanged = >%act.timestamp_dd-MM-yyyy_afterNDays_2% to fetch users modified in the last two days. This helps reduce the time taken for automation iterations by minimizing the number of records processed in each iteration.

4. 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 UKG Pro's API references to know the Parameters that must be configured to fetch only specific parameters.

• You can configure multiple endpoints for UKG Pro using the + Add API endpoint button. Click here to learn how.
  

5. To retrieve a user's personal details, configure the Person Details Endpoint. For employment details, configure the Employment Details Endpoint. To obtain both details, configure both endpoints. If additional information is required, configure the respective endpoint as per UKG Pro's API references.

6. Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in UKG Pro. ADManager Plus also lets you customize attribute format from UKG Pro.

7. 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 Primary key 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 UKG Pro.

• If you would like to create a new custom format for this, click Add New Format.

• Click Save.

8. Configure an automation with the required action, repeat frequency, and the above configured attribute mapping configuration.

 Step 3: Outbound webhook configuration 

Outbound webhook enables you to update the changes made in AD using ADManager Plus to UKG Pro and synchronize them with AD. To configure an outbound webhook for UKG Pro:

1. Under Outbound Webhook, click UKGPro CUSTOM Webhook Configuration.

2. Click + Add Webhook.

3. Enter a name and description for this webhook.

4. Decide on the action that has to be performed and refer to UKG Pro's API references for the API details such as the URL, Headers, Parameters, and other requirements that will be needed.

5. Select the HTTP method that will enable you to perform the desired action on the endpoint from the drop-down menu.

6. Enter the endpoint URL.

7. Configure the Headers, Parameters, and Message Type in the appropriate format based on the API call that you would like to perform.

8. Click Test and Save.

9. A pop-up window will display a list of AD users and groups to test the configured API call. Select the desired user or group for 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.

10. The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.

11. The configured webhooks can be integrated into Orchestration Templates—enabling scheduled or Event-driven Automation—to consecutively perform the action configured in the outbound webhook among of actions on a group of users or on individual users.

Note: Use macros to send the data of the object for which the webhook is executed.

 Tips 

• Use filters like dateTimeChanged or dateTimeCreated to retrieve only recently modified records. This significantly reduces API load and speeds up automation cycles.

• Ensure the Primary Key used in attribute mapping is consistent across all endpoints. This allows seamless correlation of user records from different UKG Pro data sets.

• Leverage macros in endpoint configuration to dynamically construct URLs or parameter values. This adds flexibility and reduces the need for hard coded changes.

• Always test endpoint configurations before enabling automation. Verifying API calls helps catch misconfigurations early and ensures reliable data sync.

• Customize LDAP attribute formats to align with UKG Pro data structures. This ensures accurate mapping during provisioning and avoids sync errors.