Overview
Torii integrates with your UKG Pro account and syncs the Users': Names, IDs, emails, roles, and statuses
Prerequisites
- You will need a UKG Pro service account to access the UKG Pro API
- Get the UKG Pro: Service Account user name, password, Customer API key, User
Get the Service account Account User Name and Password
- Go to Menu > System Configuration > Security > Service Account Administration > Add
-
Enter a user name; we recommend using Torii as the user name to be recognizable by others
-
Enter an email
Note that the password will be auto-generated upon clicking the Save button.
Save the generated password, as you will need it when connecting UKG Pro integration to Torii - In Web Service permissions provide "View" access to:
- Employee Person Details
- Personnel Integration - Once saving the settings, you will find the information, including the Customer & User API keys, under Menu > System Configuration > Security > Service Account Administration.
- Take the Service Account User Name from here
Connect UKG Pro integration to Torii
- Go to the Integrations page and select the UKG Pro tile
- Click Connect
- Enter the Account User Name from step 6 above
- Enter the Account Password you copied in step 3 above
- Enter the Customer API key & the User API key from step 6 above
- Enter the API Host URL from Menu > System Configuration > Security > Web Services
-
Report Path (optional) – If provided, the integration will sync data from the specified report using UKG’s Reports-as-a-Service API. If left empty, Torii will use the standard API.
- Click Connect
- Once the integration is connected and synced, it will display a green checkbox.
Syncing Data from Reports
Torii enables syncing user data from custom reports using the Reports-as-a-Service API. To use this option, you must create a report in UKG Pro that includes the following required fields, exactly as they appear in parentheses:
- Employee ID (employeeId)
- Email Address (emailAddress)
- First Name (firstName)
- Last Name (lastName)
- Employee Status Code (employeeStatusCode)
- Date of Termination (dateOfTermination)
- Date and Time Created (dateTimeCreated)
- Supervisor ID (supervisorID)
- Job Title (jobTitle)
- Last Hire Date (lastHireDate)
-
Department (department)
These fields are essential for the integration to function properly.
Setting Up the Report Path
In the Torii integration setup, you will find a Report Path field. If you enter a report path, the integration will sync data from the specified report. If left empty, the integration will use the standard UKG API.
To locate your Report Path, follow the instructions provided in the UKG Reports-as-a-Service documentation:
🔗 How to Find the Report Path
Update the User Lifecycle settings
To ensure you get the user lifecycle information in Torii, define the UKG Pro as your Human resource management system.
- Under Settings >> User Lifecycle, click on the Edit button to review the options
- Select UKG Pro
- In case UKG Pro is your only source for user management, make sure to uncheck Azure and Google workspace checkboxes
- Click Preview changes
-
Apply changes