Setup Guide: UKG Ready

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

• Domain
• Company Short Name
• API Key
• Service Account User ID
• Service Account Password

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

Contents

• Prerequisites
• Enter your domain in the linking flow
• Find your Company Short Name
• Find your API key
• Create a security profile
• Create your service account
• Add your service account to the linking flow

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 you have been granted access.

Enter your domain in the linking flow

For example, if you sign in at acme.com/ta/Default.login, enter acme.com.

Find your Company Short Name

1. Log in to your UKG Ready account and open the menu in the upper left. Then go to your settings icon, click Global Setup and then Company Setup.

2. Open Company Info.

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

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

Find your API key

1. In your Company Setup page, go to Login Config.

2. 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.

3. Paste your API Key into the linking flow, then press Submit.

Create a security profile

1. In your menu on the left, go to Settings > Profiles/Policies> Security. Click NEW SECURITY PROFILE on the upper right-hand side.

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

To provide access to Time Off data:

• Under TLM, navigate to Time Off Requests and enable the following permissions.

• Under Leave of Absence Management, near the bottom, select Manage Requests (if applicable).

• In your Modules tab (if applicable): Scroll to Rest API Resources. Select Employee Profiles, Employees, Employees (Changed), and Employees (me).

Create your service account

1. From Settings > Global Setup > Company Setup, go to Edit Tabs.

2. 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.

3. Click Add Service Account. To create a new account:

• Choose a username and password.

• Choose the Security Profile you created.
• Click the magnifying glass for Account Groups and select All Company Employees.

Add your service account to the linking flow

Type in the User ID and Password of the Service Account you just created to complete the linking flow.