Skip to main content
Ensure you have Admin privileges in UKG Pro to create Service Accounts and access Web Services configuration.

Set up UKG Pro access

A Service Account is a UKG Pro user created for API access. It is recommended over a Web User for API integrations.

1

Create the Service Account

Sign in to your UKG Pro account, then open Sidebar Menu > System Configuration > Security > Service Account Administration.

  • Click the Add button.
  • Username: A descriptive name for the service account
  • Copy the Username across to Service Account Username.
  • E-mail: A valid email address
2

Select the web service permissions

Enables actions: Find Compensations, Find Contacts, Find Jobs, Find People, Find User Defined Fields, Get Compensation By Employee Identifier, Get Contact By Employee Identifier, Get Employee Contact By Contact ID, Get Job By Employee Identifier, Get Person By Employee Identifier, Get User Defined Fields By Employee Identifier

In the permissions table, select the checkbox for each scope listed.

3

Save the Service Account

Click Save.

4

Copy the password and User API Key

UKG Pro generates a password and a User API Key (UserAccessKey) for the Service Account. It shows the password only once.

  • Copy the generated password across.
  • Copy the User API Key across. It appears in the grid next to the username.
5

Copy the Customer API Key

The Customer API Key (ClientAccessKey) is displayed at the top of the Service Account Administration page.

  • Copy the Customer API Key across.
6

Find the Web Services domain

Open Sidebar Menu > System Configuration > Security > Web Services, then look at any Web Services endpoint URL displayed on the page.

  • Format: https://{subdomain}.{domain}/services/...
  • Example: https://service2.ultipro.com/services/...
  • Copy the Web Service Domain across. It is the main domain, ultipro.com in the example.
  • Copy the Web Service Subdomain across. It is the subdomain prefix, service2 in the example.

Reset an expired password

Service Account passwords may expire based on your organization’s security policies.

  • In Service Account Administration, select the Service Account.
  • Click Reset Password.
  • Copy the new password across.
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.