Articles in this section

Set up a connection to UKG Pro

Naga Sri Hari Gonaboyina
Updated

UKG Pro is a cloud human capital management (HCM) solution platform that streamlines and automates administrative and HR tasks.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection *

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

Subdomain *

Enter your base API URL. For example, if your account URL is https://servicet.ultipro.com/services/, then servicet is your API URL.

Username *

Enter your UKG Pro service account username.

dataLoad.svg​​ How to retrieve the username

Password *

Enter your UKG Pro service account password.

Multiple layers of protection, including AES 256 encryption, are in place to keep your password safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the password

Customer API key *

Enter your UKG Pro service account customer API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your password safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the customer API key

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see basic auth universal connector documentation.

How to retrieve the username and password

  1. Sign in to your UKG Pro account.

  2. Navigate to Menu > System configuration > Security > Service account administration.

  3. Click Add.

  4. Enter your Username and Email.

  5. Select the required Web service permissions.

  6. Click Save.

  7. Copy the service account Username.

  8. Check Generate new password and copy the Password. For more information, see Manage service accounts.

How to retrieve the customer API key

  1. Sign in to your UKG Pro account.

  2. Navigate to Menu > System configuration > Security > Service account administration.

  3. Click Add.

  4. Enter your Username and Email.

  5. Select the required Web service permissions.

    Note: You must provide the View permission to the service account to use the customer API key for a successful connection.

  6. Click Save. You will be redirected to the Service account administration page.

  7. Copy the Customer API key. For more information, see Manage service accounts.

Additional references