UKG Ready New Hire Integration Security Profile

This article provides a comprehensive guide to setting up the Security Profile for integrating new hires in UKG Ready. It covers creating security profiles, configuring permissions, setting up service accounts, and managing additional information required for the System of Record.

In this article:
Create Security Profile
Permissions Required
Create Service Account
Additional Information Required for the System of Record
      Find your Company Short Name
      Find your API Key
Additional Resources

Create Security Profile

1. In your menu on the left, go to Settings > Profiles/Policies, and then Security.

2. Click New Security Profile on the upper right-hand side.

    

Permissions Required

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.

Type	Permissions	Visual (click image to enlarge)
Global Setup	Company Setup Contacts: View, Edit
	Global Setup Company EINs: View Cost Center Definitions: View Employee Types: View Leave of Absence Custom Fields Definitions: View
	Object Lists Company EINs: View Cost Centers: View Leave of Absence Categories: View Pay Period Profile: View
Payroll	Payroll (T&A) Company Payroll Functionality
	Payroll Pay Statements: View/Edit/Add Create/Edit Payroll Payroll Prep Process
HR	Employee Management Employee Information (My Team): View/Edit, Add Account/Personal Information (Manager Access): View/Edit Additional Compensation: View/Edit Base Compensation: View/Edit Benefit Management (Plans): View Cost Centers: View Employee Contacts: View/Edit, Add HR Custom Values: View Total Compensation: View
	HR Tables Pay Grade: View
	Leave of Absence Management Manage Requests (If applicable)
Modules	Scroll to Rest API Resources. Select the following: Employee Demographics: View, Edit Employee HR Custom Fields: View Employee Pay Information: View, Edit Employee Profiles: View Employees: View, Edit, Add Employees (Changed): View Employees (Me): View

---

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

    

4. To create a new account, enter the username and password you chose. Then, enter the Security Profile you created. 

5. Click the magnifying glass for Account Groups and select All Company Employees.

    

6. After creating the service account, confirm that the following permissions are enabled:
   • Account Information: Edit.
   • Base Compensation: View, Edit.
7. To confirm:
   1. Navigate to Global Setup> Groups > Manager Access > Find the All Company Employees group and click the pencil icon.
   2. View Group Permissions > Click the pencil icon on the ClearCompany service account (found under Group Managers).

   3. Ensure that Account Information: Edit and Base Compensation: View, Edit are checked.

       

---

Additional Information Required for the System of Record

Find your Company Short Name

Company Short Name Guide

1. Log in to 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.

   

2. Open Company Info.

    

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

    

---

Find your API Key

API Key Guide

1. In your Company Setup page, click 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.
3. If there is no key, you can click GENERATE to create one. If there are existing integrations using this key, DO NOT click generate.

---

Additional Resources

UKG Ready Bi-Directional Connector & System of Record Overview
UKG Ready Integration Overview
UKG Ready New Hire Integration Standard Setup
UKG Ready Data Synchronization