> For the complete documentation index, see [llms.txt](https://docs.harmony.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.harmony.io/integrations/hris/ukg-pro.md).

# UKG Pro

### About UKG Pro

UKG Pro (formerly UltiPro) is an enterprise HCM solution that manages the complete employee lifecycle from recruitment to retirement, including payroll, benefits, talent, and workforce management. Connecting UKG Pro to Harmony enables automated IT provisioning based on HR events, intelligent workforce management, and seamless organizational synchronization.

### What the UKG Pro integration enables

| Capability                    | Description                                                        |
| ----------------------------- | ------------------------------------------------------------------ |
| Employee Lifecycle Automation | Trigger IT actions based on hire, transfer, and termination events |
| Organizational Sync           | Maintain current org structure and reporting relationships         |
| Role-Based Provisioning       | Automatically provision access based on job roles                  |
| Lifecycle Automation          | Automate IT tasks for role changes, transfers, and promotions      |

### Prerequisites

* **UKG Pro Administrator Access**: System administrator role with API access
* **UKG Pro Subscription**: Active UKG Pro subscription with API entitlements
* **API Credentials**: Service account credentials from UKG
* **Harmony Account**: Active Harmony workspace

### Connect UKG Pro to Harmony

#### Step 1: Create API Service Account in UKG Pro

1. Log in to UKG Pro as system administrator
2. Navigate to **System Configuration** > **Security** > **Service Accounts**
3. Click **Add Service Account**
4. Configure:
   * **Username**: `harmony_integration_svc`
   * **Description**: "Harmony IT Operations Integration"
   * **Authentication Type**: API Key
   * **API Permissions**: Employee Data (Read), Organizational Data (Read), Employment Records (Read), Custom Fields (Read)
5. Click **Generate API Key** and copy the **Customer API Key**

#### Step 2: Navigate to Integrations

1. Log in to your Harmony dashboard
2. Go to **Settings** > **Integrations**
3. Find **UKG Pro** under **HRIS** and click **Connect**

#### Step 3: Enter API Credentials

1. Enter your **UKG Instance URL**
2. Enter your **Customer API Key**
3. Click **Connect**

### What Harmony Syncs

**From UKG Pro:**

* Employee profiles (name, contact info, employee number)
* Employment details (job title, department, business unit, division)
* Organizational data (manager, supervisor, reporting hierarchy)
* Position information (position code, job code, grade, level)
* Employment status (active, pending, terminated, LOA)
* Work location and remote status
* Employment dates (hire date, termination date)
* Custom fields relevant to IT operations

### Use Cases

<details>

<summary>Enterprise-Scale Onboarding</summary>

Automate IT provisioning for large cohorts of new hires using UKG Pro employee data

</details>

<details>

<summary>Position-Based Access Control</summary>

Dynamically adjust permissions when employees are promoted or change positions

</details>

<details>

<summary>Seamless Offboarding</summary>

Automate complete access removal and asset recovery when employees are terminated

</details>

<details>

<summary>Department Reorganization</summary>

Automatically update IT access and group memberships during corporate restructuring

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.harmony.io/integrations/hris/ukg-pro.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
