Skip to main content

Configure Connection

UltiPro UKG Pro guide

Create a dedicated UKG Pro service account, assign the required read permissions, and collect the web-service details for NIM.

Before you begin​

You need a UKG Pro administrator account with access to Service Account Administration and Web Services.

Create the service account​

  1. Sign in to UKG Pro with an administrator account.
  2. Open Service Account Administration and create a dedicated service account for NIM.
  3. Set a username and password for the account. Record both values securely; NIM does not require the account’s email address.
Use a dedicated account

Avoid using an individual administrator’s account. A dedicated service account makes access reviews, credential rotation, and troubleshooting more reliable.

Assign required permissions​

Assign the following View permissions to the NIM service account. These are required permissions, not additional configuration steps.

SelectPermissionAccess level
☐Employee Person DetailsView
☐Personnel IntegrationView
☐Company Configuration IntegrationView
☐Employee Phone InformationView
Verify every permission

Missing permissions can cause incomplete reads or authorization errors. Confirm that all four entries above are assigned before testing the NIM connection.

Collect web-service details​

  1. In UKG Pro, navigate to System Configuration > Security > Web Services.

  2. Record the following values:

    ValueUsed by NIM
    Customer API KeyIdentifies your organization’s UKG Pro API access.
    Employee Person Service endpoint URLDirects NIM to the appropriate UKG Pro employee service.

Configure and validate NIM​

  1. Add or open the UltiPro UKG Pro system in NIM.
  2. Enter the service account username and password, Customer API Key, and Employee Person Service endpoint URL in the corresponding connection settings.
  3. Save the system and run a read or connection test.
  4. If authorization fails, verify the service-account credentials and each required View permission.