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.

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: Create Organization Level, Create PTO Plan, Get Compensation Details By Employee, Get Employee Contact Details, Get Employee Last Pay Statement, Get Employee Pay Statements, Get Employee Security User Details, Get International Employee Details, Get Job Configuration, Get Location Configuration, Get PTO Plan, Get Pay Register, Get Person Details, Get Security Roles, Get User Details, List Business Structure Changes, List Company Details, List Compensation Details, List Dependent Deductions, List Direct Deposits, List Earnings Configurations, List Earnings History, List Employee COBRA Details, List Employee Changes By Date, List Employee Changes By Employee ID, List Employee Contacts, List Employee Deductions, List Employee Job History Details, List Employee Multiple Phone Numbers, List Employee PTO Plans, List Employee Positions, List Employee Supervisor Details, List Global Employee Bank Accounts, List Global Localization Elements, List International Employees, List Job Configurations, List Job Groups, List Location Configurations, List Open Enrollment Employee Deductions, List Organization Levels, List PTO Plans, List Pay Group Pay Periods, List Payroll Deductions History, List Person Details, Update PTO Plan

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

3

Save the Service Account

Click Save.

4

Copy the password

UKG Pro generates a password for the Service Account and shows it only once.

  • Copy the generated password across.
5

Copy the Customer API Key

The Customer API Key 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.