• Overview
  • Configuration

Related-apps

UKG Ready

Automate user lifecycle management with UKG Ready and ADManager Plus

HCM Identity provisioning

UKG Ready is a comprehensive workforce management solution that helps organizations manage employee time, attendance, HR, and payroll. Integrating UKG Ready with ADManager Plus allows IT administrators to automate user provisioning, updates, and permission management based on Active Directory (AD) data. This streamlines the management of employee life cycles, ensuring timely access to resources while maintaining security by revoking permissions for departed employees.

 

User onboarding and offboarding

Automate the creation of user accounts during onboarding and ensure seamless deactivation or deletion during offboarding based on AD changes.

 

User data synchronization

Synchronize employee data between AD and integrated systems in real time, ensuring that changes, such as department transfers, job titles, or contact details, are accurately reflected across platforms.

 

Enhanced compliance

Ensure data consistency across HR and IT systems by automatically synchronizing and updating user information. This integration helps organizations meet audit and compliance requirements by maintaining accurate, up-to-date records and enforcing standardized policies.

 

How to configure integrate UKG Ready integration in ADManager Plus

Pre-requisites:

Please ensure to provide the API key and credentials to retrieve desired information and perform tasks in UKG Ready. Refer to UKG Ready 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 UKG Ready (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 UKG Ready 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 UKG Ready.
  • Toggle the Enable UKG Ready Integration button on.
  • In the UKG Ready Configuration page, click Authorization.
  • Choose Bearer as the authorization type for the API integration.
  • Navigate to and click on the API widget within the integration configuration panel to configure custom authentication.
  • In the API for Authorization window:
    • Go to the Endpoint URL field and replace {hostname} with the hostname of your UKG Ready instance.
    • Under the Headers section, enter the API-Key associated with your UKG Ready instance.
    • In the Message Type field, replace placeholders {username}, {password}, and {company} with the corresponding credentials and company identifier for your UKG Ready instance.
    • Click on the Test and Configure button to validate the settings and complete the integration.
    • Select the generated access token and click Save.
  • Click Configure.

Inbound webhook configuration

Inbound webhook enables you to fetch user data from UKG Ready to ADManager Plus. The attribute mapping configured in this section can be selected as the data source during automation configuration. To configure an inbound webhook for UKG Ready:

  • Under Inbound Webhook, click UKG Ready Endpoint Configuration.
  • In the Endpoint URL field, replace {hostname} with the hostname of your UKG Ready instance.
  • Enter the appropriate API-Key associated with your UKG Ready instance in the Headers section.
  • Replace {username}, {password}, and {company} in the Message Type field with the respective credentials for your UKG Ready instance.
  • Click Test and Configure to validate the settings and complete the configuration process.
  • 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 UKG Ready's API references to know the Parameters that must be configured to fetch only specific parameters.
    • You can configure multiple endpoints for UKG Ready 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 UKG Ready.
  • 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 attribute in UKG Ready.
    • 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 UKG Ready, and carry out tasks in UKG Ready—all 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 on desired users to perform a sequence of actions on them (Management > Advanced Management > Orchestration).To configure outbound webhooks for UKG Ready:

  • Under Outbound Webhook, click UKG Ready 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 UKG Ready'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.