Skip to content

Integrating SailPoint with UKG Pro Core HCM

Integration

This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager.

This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a UKG Pro Core HCM source in SailPoint.

Note

To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the SaaS Release Notes page.

Supported Features

SailPoint UKG Pro Core HCM Connector supports the following features:

Account Management

  • Aggregate UKG Pro Core HCM employee records
  • Delta aggregation to sync changes from UKG Pro Core HCM
  • Additional schema attribute support
  • Aggregation of records based on future hire, terminations, and various employment status
  • Update account provisioning

Additional Supported Features

  • Support for aggregation and update of custom user defined attributes
  • Support for aggregation of platform configuration attributes

Supported Managed Systems

The UKG Pro Core HCM connector supports the following versions of the UKG Pro Core HCM API:

  • UKG Pro Core HCM API version 1
  • UKG Pro Core HCM API version 2 for Platform Configuration Fields Data API

Note

The UKG Pro Core HCM connector uses the UKG Pro Core HCM's REST API, which is independent of the UKG Pro Core HCM system version.

Prerequisites

  • Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the Virtual Appliance Reference Guide.

  • Have a UKG Pro Core HCM Web Service Account, Password, and Customer API Key for connecting to the given URL of the UKG Pro Core HCM tenant.

Note

For more information on UKG Pro Core HCM permissions, refer to Required Permissions.

Required Permissions

This section describes the permissions required for the UKG Pro Core HCM application on the UKG Pro Core HCM managed system.

Permissions for authentication type:

Basic Authentication

This topic provides the details of the required permissions for the Basic Authentication Type.

Creating a Web Service Account

UKG Pro APIs using Basic Authentication are only accessible with a web service account. UKG Pro users with system administrator rights can create web service accounts by going to System Configuration > Security > Service Account Administration. Like user accounts, web service accounts require a unique username, password, and granular permissions. Permissions can be granted to one or more resource or method.

Go to the Service Account Administration page and add a new service account user. When you select Save, the password displays.

Important

Copy the password as it will not be shown again.

For more information, refer to the UKG Developer Hub.

Permissions to UKG Pro Core HCM Web Service Account User

Modify the Web Service User to associate the required permissions for the following UKG Pro Core HCM Web Services:

Operation Comments
TEST CONNECTION The service account must have the View role for the Company Configuration Integration Web Service.
ACCOUNT AGGREGATION The service account must have View role for the Employee Export Web Service.
ACCOUNT AGGREGATION (for additional attributes) To aggregate Job Configuration Details, Location Configuration Details, and Org level (½/¾) Details, the service account must have the View role for the Company Configuration Integration Web Service. To aggregate Employment Details, User Defined Field Details, and Platform Configuration Field Details, the service account must have View role for the Personnel Integration Web Service.
PROVISIONING The service account must have the View role for the Company Configuration Integration Web Service AND View and Add roles for the Personnel Integration Web Service.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.