> 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

Streamline enterprise HR and payroll with UKG Pro-driven IT provisioning and access workflows

### 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**: A web service account (username and password) and your Customer API Key from UKG Pro
* **Harmony Account**: Active Harmony workspace

### Connect UKG Pro to Harmony

#### Step 1: Create a Web Service Account in UKG Pro

1. Log in to UKG Pro as system administrator
2. Navigate to **Menu** > **System Configuration** > **Security** > **Service Account Administration**
3. Click **Add** and enter a unique user name that is not used for portal access, for example `harmony_integration_svc`, and an email address
4. Keep **Generate New Password** selected, click **Save**, and copy the generated password
5. Click the new account's user name and give it **View** access to the web services that return employee data. Harmony only reads data, so Add, Edit, and Delete access are not needed
6. Navigate to **Menu** > **System Configuration** > **Security** > **Web Services**, copy the **Customer API Key**, and note the host of your base service URL, for example `service2.ultipro.com`

#### Step 2: Navigate to Integrations

1. Log in to your Harmony dashboard
2. Go to **Settings** > **Integrations**
3. Find **UKG Pro** under **HRIS** (or search for it by name) and click its card

#### Step 3: Enter API Credentials

1. Enter your **API server**: the host of your base service URL only, without `https://` or a path, for example `service2.ultipro.com`
2. Enter the **Username** of the web service account
3. Enter the **Password** of the web service account
4. Enter your Customer API Key in the **API key** field
5. Click **Connect**

### What Harmony Syncs

**From UKG Pro:**

* Employee profiles (name, contact info)
* Employment details (job title, department)
* Organizational data (manager, reporting hierarchy)
* Employment status (active, inactive, terminated)
* Work location
* Employment dates (hire date, termination date)

### 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.