Identity and access management
UKG Pro to Omada integration: UKG Pro as HR source for identities in Omada Identity
With an integration between UKG Pro and Omada Identity, every employee from UKG Pro becomes an identity in Omada, with company and organisation levels as context and the supervisor as owner, so roles and reviews run on HR data. Omada has no UKG connector; KoppelHet sets up Omada's REST collector on the UKG Pro Personnel API, with the sign-in, pagination and schedule UKG prescribes.
What the integration does
Organisations with UKG Pro as HR system, often with headquarters in the United States, and Omada Identity for identity governance often load employees through an export from UKG. A file that is a day old makes reviews run on outdated departments, and a leaver keeps roles until the next export.
- In UKG Pro the administrator creates a service account with only View on the Employee Export web service.
- Together with you we record which of the four organisation levels is the department and which companies belong in Omada.
- In Omada we set up the REST collector with Basic sign-in, the UKG customer key as a header and pagination with page and per_page.
- We set thresholds for new, changed and deleted objects and run a trial import.
- After that the import runs on a schedule that respects UKG's three-hour minimum.
What to watch for with UKG Pro and Omada
- There is no UKG connector in Omada's Connectivity Directory or documentation. The UKG Pro Personnel API does return JSON with Basic sign-in, and Omada's REST collector supports Basic plus custom headers. Omada can therefore read UKG Pro itself; KoppelHet sets that up and builds no intermediate layer.
- Besides username and password, UKG Pro requires the US-CUSTOMER-API-KEY header on every call, unique per UKG tenant. In Omada we put that key in the connection headers, not in the URL, so it does not appear in the import's log lines.
- UKG advises calling the changes service at most eight times a day, with at least three hours in between. We therefore set the import schedule in Omada to three hours or longer. A departure already entered ahead in UKG is still applied on the right day by Omada through the end date.
- UKG returns at most two hundred employees per page, with page and per_page. Omada's REST collector can paginate with URL parameters and reads on until an empty result if there is no total. KoppelHet sets per_page to two hundred and page to Omada's counter.
- UKG Pro has four organisation levels that each organisation fills in itself, plus a companyId per legal company. KoppelHet makes each level in use a separate context type in Omada, so roles can run on the Dutch department level without losing the American level.
- On a rehire UKG keeps dateOfLastHire next to the original date. KoppelHet uses employeeId as business key and dateOfLastHire as ValidFrom, so a returning colleague lands on their existing identity, with history and earlier reviews.
- Omada warns that a status from an HR source can overwrite a status set in Omada itself. UKG supplies both isActive and an employeeStatus, such as leave. KoppelHet decides with you which UKG statuses remain active in Omada, and does not let the import lift a manual block in Omada.
This integration is also part of joiner, mover, leaver.
How we build and run it
- The integration runs on the KoppelHet platform, hosted in a data centre in the EU.
- Every sync and every error is visible in the functional log; on an error your administrator is notified.
- A change that cannot go through is not half-applied but queued for another attempt.
- KoppelHet is ISO 27001 certified. Data travels encrypted and stays on the platform no longer than needed.
- After go-live we manage the integration and adjust it when your process changes.
- The integration fits next to your existing integration layer. Only the fields in the design are transferred; the platform keeps no register of its own.
Implementation and price
This is not an app you switch on. We build the integration for your organisation on our platform, with building blocks we reuse on every project. So it is custom work that does not start from scratch.
A consultant prepares the intake and analyses both systems. We then record the mapping and exceptions field by field, test in the test or acceptance environment and go live at a moment you choose. Costs are a one-off amount for the setup and a monthly amount for platform, monitoring and support.
Frequently asked questions
Why does the import not run hourly?
UKG asks for at least three hours between two calls to the changes service. End dates entered ahead are still processed by Omada on the right day.
Which rights does the service account get in UKG?
Only View on the Employee Export web service. Pay and other data stay out of reach.
Is a leaver removed from Omada?
No, the identity gets an end date and remains for audits.
Technical details for IT
For those who want to know how it works under the hood: APIs, fields and sources used.
- UKG Pro Personnel API: GET {hostname}/personnel/v1/employee-changes with Authorization Basic (base64 of username:password) and US-CUSTOMER-API-KEY; service account with View on the EmployeeExport Web Service; page and per_page (maximum 200), optional startDate and endDate; at least three hours between calls. Fields include employeeId, employeeNumber, companyId, orgLevel1Code to orgLevel4Code, jobCode, supervisorId, isActive, employeeStatus, hireDate, dateOfLastHire, terminationDate and countryCode.
- Omada REST collector (Content: Identity data): Basic authentication, US-CUSTOMER-API-KEY in the connection Headers (JSON), URL parameters pagination without Total; required identity mapping Business key, Unique ID, Name and Status; contexts per organisation level, context assignments and identity owners; thresholds per import (default 0); timeout default 3600 seconds.
Which fields are transferred
The key fields. The full mapping is agreed per customer.
| Field in UKG Pro | Field in Omada | Notes |
|---|---|---|
employeeId | Business key en Unique ID | |
firstName, preferredName, lastName | Name, FirstName, LastName | |
emailAddress | Email | |
isActive, employeeStatus | Status | |
dateOfLastHire, terminationDate | ValidFrom, ValidTo | |
companyId | Context (bedrijf) | |
orgLevel1Code tot orgLevel4Code | Contexten (organisatieniveaus) en context assignments | |
supervisorId | Identity owner | |
jobCode, employeeType, countryCode | Extensieattributen voor rolregels |
Related
Recruitee → UKG Pro
Recruitee to UKG Pro integration: European hires through the Global New Hire service in UKG Pro
Teamtailor → UKG Pro
Teamtailor to UKG Pro integration: European hires as global new hires
UKG Pro → Active Directory
UKG Pro to Active Directory integration: domain accounts for the Dutch branch
UKG Pro → ADP iHCM
UKG Pro to ADP iHCM integration: salary and terminations of the Dutch pay group to ADP