Overview
To authenticate with UKG Ready, you need:
- Client ID - Your OAuth application’s client identifier
- Client Secret - Your OAuth application’s secret key
- Company ID - Your unique company identifier in UKG
- Hostname - Your UKG Ready instance’s hostname (e.g., secure.us.rdy.ukg)
This guide will walk you through obtaining these within UKG Ready.
Prerequisites:
- You must have an account with UKG Pro system administrator.
Instructions:
Step 1: Generating Your Client Credentials
- Sign in to your UKG Ready account.
- You should have your dedicated login URL like
https://secure.us.rdy.ukg/ta/company.login
- You should have your dedicated login URL like
- Go to Settings > Global Setup > Company Setup.
- Find the OAuth Applications widget.
- Choose the Machine to Machine type, and generate a Client ID and Client Secret.
Step 2: Finding Your Company ID
- Click the hamburger ☰ button.
- Navigate to My team > My employees > Employee info.
- Click Select columns.
- For detailed information, see Get company ID.
- Select Add/Remove columns.
- Add Company ID.
- Click Apply.
- Your Company ID will be displayed for you.
Step 3: Finding Your Hostname
- Click the hamburger ☰ button on the top left.
- Click Settings menu option, then click Global Setup to expand the menu.
- Click Company Setup.
- This page will display your Hostname. This value is contained in your domain’s URL login.
-
Example: If your login service URL is listed as
https://secure.us.rdy.ukg/ta/company.login, then your Hostname issecure.us.rdy.ukg
-
Example: If your login service URL is listed as
Step 4: Enter credentials in the Connect UI
Once you have your credentials:
- Open the form where you need to authenticate with UKG Ready.
- Enter your Client ID, Client Secret, Company ID and Hostname in their respective fields.
- Submit the form, and you should be successfully authenticated.
Baseline Fields that will be Synced:
- Baseline fields are the standard fields across all HRIS integrations. This helps with demographic charts, exit surveys, and pushing data back accurately.
- exception: any field with
payorsalaryinfo will NOT be pulled in and is excluded.
Field |
Value Type |
| id | string |
| firstName | string - Required |
| lastName | string |
| string - Required | |
| displayName | string |
| employeeNumber | string (optional) |
| title | string |
| department.id | string |
| department.name | string |
| employmentType | 'FULL_TIME' |
| employmentStatus | 'ACTIVE' |
| startDate | string (ISO date) |
| terminationDate | string (ISO date, optional) |
| manager.id | string (optional) |
| manager.firstName | string (optional) |
| manager.lastName | string (optional) |
| manager.email | string (optional) |
| workLocation.name | string |
| workLocation.type | 'OFFICE' |
| workLocation.primaryAddress.street | string (optional) |
| workLocation.primaryAddress.city | string (optional) |
| workLocation.primaryAddress.state | string (optional) |
| workLocation.primaryAddress.country | string (optional) |
| workLocation.primaryAddress.postalCode | string (optional) |
| workLocation.primaryAddress.type | 'WORK' |
| addresses[].street | string |
| addresses[].city | string |
| addresses[].state | string |
| addresses[].country | string |
| addresses[].postalCode | string |
| addresses[].type | 'HOME' |
| phones[].type | 'WORK' |
| phones[].number | string |
| emails[].type | 'WORK' |
| emails[].address | string |
| createdAt | string |
| updatedAt | string |
UKG Ready Specific Fields
UKG Ready Specific fields |
| username |
| links |
| startedDate |
| middleName |
| nickname |
| suffix |
| photoHref |
| isPhotoUploaded |
| locked |
| forceChangePassword |
| timezone |
| useSeparateMailingAddress |
| birthday |
| managers |
| costCentersInfo |
| addToNewHireExport |
| hardwareSettings |
| managedCostCentersEnabled |