UKG Ready and 5Mins AI

Overview

To authenticate your UKG Ready account, you will need to have the following information:

  • Domain Company

  • Short Name

  • API Key

  • User ID

  • Password

  • Magic Link provided by Customer Success team

This guide will walk you through finding or creating those credentials within UKG Ready.

Prerequisites

Please ensure you fulfill all the requirements to set up the integration:

  • You are an Administrator in your company's UKG Ready instance, or someone has shared their access with you.

  • You have the magic link provided by the 5mins Customer Success Team

Instructions

Step 1:

Enter your Domain in the Magic link flow For example, if you sign in at "acme.com/ta/Default.login", enter "acme.com"

Step 2:

Find your Company Short Name Log into your UKG Ready account and open the menu in the upper left. Then, go to your settings icon and click on Global Setup, followed by Company Setup

  • Open Company Info

  • Scroll down to find Company Short Name under Company Address. Copy your Company Short Name

  • Paste your Company Short Name in the linking flow and click Submit

Step 3:

  • Find your API Key In your Company Setup page, go to Login Config

  • Scroll to find API Keys and click the eye icon to reveal the key. Copy the API Key and store it in a secure place

    If there is no key, you can click GENERATE to create one. If there are existing integrations using this key, DO NOT click generate

  • Paste your API Key in the linking flow and press Submit

Step 4:

  • Create a security profile In your menu on the left, go to Settings, Profiles/Policies, and then Security. Click NEW SECURITY PROFILE on the upper right-hand side

  • In this profile, we want to ensure all relevant permissions are enabled for the following endpoints.

​Note these permissions may be different based on your specific use case. For employee information use case, select most of the permissions where Employee information such as their names, email address, EmployeeID, managers, locations, teams etc exist

In your HR Tab:

Find Employee Management, Select View from the drop-down menu.

  • Select Employee Information (My Team) as view

  • Select Termination Details as View

  • Select HR Custom values as View

In your Modules tab :

Scroll to Rest API Resources. Select Employee HR Custom Fields, Employee Profiles, Employees, Employees (Changed) and Employees (me) as View

Step 5:

Create your service account From Settings > Global Setup > Company Setup, go to Edit Tabs

From the Available Windows box on the right side of the screen, scroll down to Service Accounts. Drag it to the Top section in the middle. Click Save

Click Add Service Account. To create a new account, enter the username and password you chose. Then, enter the Security Profile you created. Click the magnifying glass for Account Groups and select All Company Employees

Step 6:

Add your service account to the linking flow Type in your service account User ID and Password to complete the linking flow.

That’s it! The account is linked.