Prerequisites

• You need to be an Administrator of your UKG Ready instance.

Instructions

Find the URL Domain

1. Click Continue
   
    
2. Go to your UKG Ready Dashboard and copy the entire URL.
   
    
3. Paste the URL into the connection flow. Ensure that the part "/ta/acme.home" is included.
   

Create a Security Profile

In order to grant access to your application, you will need to create a new security profile that contains the necessary permissions.

1. Search for "security" in the search bar at the top of the page then select Security (Profiles / Policies) in the search results.
   
   
    

    

2. Click "New Security Profile" in the top right corner.
   
    

    

3. Set the permissions according to the connection flow

   This section of the guide shows where to find every permission we ask for in UKG Ready.

   Refer to your connection flow to see the sub-list of permissions we need based on your use case.
   
    

    

4. Add the permissions in each section

Modules Section > REST API Resources

HR Section > Recruitment

HR Section > Employee Management

Reports Section > Reports

5. Finally, give the security profile a Name and click "Save".
   
   
    
6. Return to the connection flow, and click "Continue".
   

Create an OAuth App

1. Navigate to "Global Setup > Company Setup".
   
2. If you do not see the "OAuth Applications" window: Click on "Edit Tabs".
   
3. In the list of "Available Windows" scroll down until you find "OAuth Applications". Drag "OAuth Applications" into one of the columns. Then click "Save" and go back.
   
4. Click the "Add OAuth Application" button.
   
5. Fill out the information.
   Select the Security Profile that you created (see above).
   
6. Click "Generate Secret", then copy the "Client Id" and "Secret" to the connection flow.
   
   After entering all details, first click "Save" in UKG Ready, then click "Set up integration" in the connection flow.
   
7. Congratulations!