UKG integration
Overview
UKG, or Ultimate Kronos Group, is a global human capital management (HCM) software company that provides cloud-based solutions for workforce management, talent acquisition, and benefits administration.
Availability
β General availability. The UKG integration is available to all ConductorOne users.
Capabilities
- Sync user identities from UKG to ConductorOne
- Resources supported:
- Roles
Set up the UKG integration
A user with the Super Administrator role in ConductorOne must perform this task.
In ConductorOne, open Administer and click Integrations > UKG.
If this is your first UKG integration, the integration form opens automatically. Otherwise, click Add connector.
Choose whether to add the new UKG connector to an existing application (and select the app of your choice) or to create a new application.
Do you SSO into UKG using your identity provider (IdP)? If so, make sure to add the connector to the UKG app that was created automatically when you integrated your IdP with ConductorOne, rather than creating a new app.
Set the integration owner for this connector. You can manage the integration yourself, or choose someone else from the list of ConductorOne users. Setting multiple integration owners is allowed.
A UKG integration owner must have the following permissions:
- Integration Administrator or Super Administrator role in ConductorOne
- Permission to create a service account in UKG Pro
- Click Create and add details.
Next steps
If you are the integration owner, proceed to Integrate your UKG instance for instructions on integrating UKG with ConductorOne.
If someone else is the integration owner, ConductorOne will notify them by email that their help is needed to complete the integration.
Integrate your UKG instance
A user with the Integration Administrator or Super Administrator role in ConductorOne and permission to create a service account in UKG Pro must perform this task.
Step 1: Look up your UKG customer API key
Log into UKG Pro and navigate to the Service Account Administration page by using the search bar.
Locate the Customer API Key at the top of this page. Carefully save this API key, we’ll use it in Step 4.
Step 2: Create a service account
Still on the Service Account Administration page, click Add to create a new service account.
Give the new service account a name such as “ConductorOne integration” and enter the email address you want to associate with the account.
Click to enable the Generate New Password checkbox.
Give the service account the View role on the following web services:
- Employee Export
- Personnel Integration
- Company Configuration Integration
Scroll to the top of the page and click Save.
A new password is generated for the service account. Make a careful note of this password, we’ll use it in Step 4 along with the service account’s username.
Step 3: Locate your service endpoint
Use the UKG search bar to navigate to the Web Services page.
The list of web services for your UKG instance are formed like
https://example.ultipro.com/services/endpoint-name
. Carefully copy the scheme (https://
) and domain name (example.ultipro.com
) but do not include the subdirectory path (which begins with/services
in our example). In our example, you’d copyhttp://example.ultipro.com
. This is your service endpoint.Save the service endpoint. We’ll use it in Step 4.
Step 4: Add your UKG credentials to ConductorOne
In ConductorOne, open Administer and click Integrations > UKG.
In the list of connectors, locate and click on the name of the connector with the Not connected label.
Find the Settings area of the page and click Edit.
In the Customer API Key fields, enter the API key you looked up in UKG in Step 1.
In the Username and Password fields, enter the username and password for the service account you created in Step 2.
In the Service Endpoint field, enter the service endpoint as described in Step 3.
Click Save.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.
If you encounter a 403 error at this point in the process, double-check the permissions on your service account and try again.
That’s it! Your UKG instance is now integrated with ConductorOne.
Configure the UKG integration using Terraform
As an alternative to the integration process described above, you can use Terraform to configure the integration between UKG and ConductorOne.
See the ConductorOne UKG integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.