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 beginDirect link to Before you begin
You need a UKG Pro administrator account with access to Service Account Administration and Web Services.
NIM requires Tenant URL, Client Access Key, User Access Key, Username, and Password.
Create the service accountDirect link to Create the service account
- Sign in to UKG Pro with an administrator account.
- Open Service Account Administration and create a dedicated service account for NIM.
- Set a username and password for the account. Record both values securely; NIM does not require the account’s email address.
Avoid using an individual administrator’s account. A dedicated service account makes access reviews, credential rotation, and troubleshooting more reliable.
Assign required permissionsDirect link to Assign required permissions
Assign the following View permissions to the NIM service account. These are required permissions, not additional configuration steps.
| Select | Permission | Access level |
|---|---|---|
| ☐ | Employee Person Details | View |
| ☐ | Personnel Integration | View |
| ☐ | Company Configuration Integration | View |
| ☐ | Employee Phone Information | View |
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 detailsDirect link to Collect web-service details
-
In UKG Pro, navigate to System Configuration > Security > Web Services.
-
Record the following values:
Value Used by NIM Customer API Key Used as the Client Access Key for the REST connector. Employee Person Service endpoint URL Identifies the UKG service host for your environment. Confirm the REST host with your administrator. -
Obtain the User Access Key required by the NIM Connection screen from your UKG Pro administrator.
Configure and validate NIMDirect link to Configure and validate NIM
- Add or open the UltiPro UKG Pro system in NIM.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The UKG Pro REST service host for your environment. The public connector adds https://; enter the host without that prefix or a SOAP service path. |
| Client Access Key | The Customer API Key from Web Services, used by the REST connector as US-Customer-Api-Key. |
| User Access Key | The user access key supplied or confirmed by your UKG Pro administrator. |
| Username | The dedicated service account's username. |
| Password | The corresponding service-account password. |
Test company-details retrievalDirect link to Test company-details retrieval
-
Select Test Connection. NIM attempts to retrieve company details using:
GET /configuration/v1/company-details -
If authorization fails, verify the Tenant URL, access keys, service-account credentials, network access, and each required View permission.
-
Collect the workforce data required by your process and confirm that the expected records are present.
-
Validate identity matching and field mappings before using the data for downstream user provisioning.
The connection test checks company-details retrieval. Validate employee collections and field access required by your process separately.