> ## Documentation Index
> Fetch the complete documentation index at: https://stackone-hub-docs-confluence-api-token-update.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# UKG Pro

> Follow these steps to connect UKG Pro with StackOne Hub successfully.

<Warning>
  Ensure you have Admin privileges for your UKG Pro account.
</Warning>

If you've been directed to StackOne to integrate with UKG Pro, the following steps will help you understand the process and any necessary actions to configure successful integration.

This guidance assumes you have Admin privileges for your UKG Pro account.

## Getting your UKG Company Domain and Subdomain

<Steps>
  <Step title="Login to UKG Pro">
    Login to your UKG Pro account and search for Web Services in the search bar at the top right.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Web Services Search" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image1.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=2168e16605c9789f2d80bb0eeedd1827" width="433" height="180" data-path="images/ukgpro/image1.png" />
    </Frame>
  </Step>

  <Step title="Copy Domain">
    Copy the domain from any Web Services URL. For example, if your URL is `http://Servicet.ultipro.com/services/BIDataService`, copy `ultipro.com`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Subdomain Example" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/ukgpro-domain.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=66583d599038501b4354e06c48fade0c" width="813" height="473" data-path="images/ukgpro/ukgpro-domain.png" />
    </Frame>
  </Step>

  <Step title="Copy Subdomain">
    Copy the subdomain from any Web Services URL. For example, if your URL is `http://Servicet.ultipro.com/services/BIDataService`, copy `Servicet`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Subdomain Example" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image2.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=56ddf7afe0dc4293363b53deb994fd09" width="813" height="473" data-path="images/ukgpro/image2.png" />
    </Frame>
  </Step>
</Steps>

## Retrieving your UKG Pro Customer API key

<Steps>
  <Step title="Search for Service Account Administration">
    Search for Service Account Administration in the search bar.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Service Account Administration" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image3.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=2034f7d907ac5f2184f5778a816a99ae" width="699" height="375" data-path="images/ukgpro/image3.png" />
    </Frame>
  </Step>

  <Step title="Copy Customer API Key">
    Copy the Customer API Key located under the header.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Customer API Key" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image4.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=6a50a01ef2bcfc28a05e8e79e0ad2080" width="1144" height="480" data-path="images/ukgpro/image4.png" />
    </Frame>
  </Step>
</Steps>

## Creating a Service Account

<Steps>
  <Step title="Add Service Account">
    On the UKG Pro Service Account Administration page, click ➕ add in the upper right corner.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Add Service Account" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image5.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=3c527b1621c2947986182ceb8a813549" width="1033" height="177" data-path="images/ukgpro/image5.png" />
    </Frame>
  </Step>

  <Step title="Enter Admin Details">
    Enter your admin's username and email address.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Admin Details" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image6.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=a3559a60c4da805d120240c433269ceb" width="928" height="480" data-path="images/ukgpro/image6.png" />
    </Frame>
  </Step>

  <Step title="Assign Permissions">
    Scroll down to the Web Service table below and select the following permissions required for the full set of operations supported by this integration:

    | Web Service                       | Add | View | Edit |
    | --------------------------------- | --- | ---- | ---- |
    | Employee Person                   |     | ✓    | ✓    |
    | Employee Address                  |     | ✓    | ✓    |
    | Employee Contacts                 | ✓   | ✓    | ✓    |
    | Employee Job                      |     | ✓    | ✓    |
    | Employee Compensation             |     | ✓    | ✓    |
    | Employee Pay Statement            |     | ✓    |      |
    | Employee User Defined Fields      |     | ✓    | ✓    |
    | Employee Employment Information   |     | ✓    | ✓    |
    | Employee Phone Information        |     | ✓    | ✓    |
    | Employee Termination              |     | ✓    |      |
    | Employee Process Hire             |     | ✓    |      |
    | Employee Self Service API         |     | ✓    |      |
    | Company Configuration Integration |     | ✓    | ✓    |
    | Personnel Integration             |     | ✓    | ✓    |
    | Employee Job History Details      |     | ✓    |      |
    | Employee Person Details           |     | ✓    |      |
    | Employee Compensation Details     |     | ✓    |      |

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Assign Permissions" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image7.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=9be91a08948ecc47e0db98efb705e651" width="805" height="286" data-path="images/ukgpro/image7.png" />
    </Frame>
  </Step>

  <Step title="Save and Generate Password">
    Click Save to generate a new password. Save this password in a secure location.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Generate Password" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image8.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=afd9c37021cc788d0ed4856479e44003" width="453" height="247" data-path="images/ukgpro/image8.png" />
    </Frame>
  </Step>

  <Step title="Save Service User Credentials">
    Make a note of the service account credentials:

    * Service Account Username
    * Service Account Password
    * Service Account User API Key (shown below on the *Service Account Administration* page)

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Service User API Key" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukg-pro-service-user-api-key.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=8a65b11f3c46327cf4177507a75d1582" width="914" height="456" data-path="images/ukg-pro-service-user-api-key.png" />
    </Frame>
  </Step>
</Steps>

## Connecting to StackOne

<Steps>
  <Step title="Enter Details">
    Enter the following credentials received from the previous steps:

    * Service Account Username (from Step 3)
    * Service Account Password (from Step 3)
    * User API Key (from Step 3)
    * Customer API Key (from Step 2)
    * Web Service Domain (from Step 1)
    * Web Service Subdomain (from Step 1)

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Link Account" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgpro/image9.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=72e3c7c696901ca42bc90a97f7970907" width="484" height="729" data-path="images/ukgpro/image9.png" />
    </Frame>
  </Step>
</Steps>

<br />

Congratulations, you're all set! If you face any issues with the steps mentioned above,
please contact us by emailing [integrations@stackone.com](mailto:integrations@stackone.com). We're always here to assist you!

## Useful Links

<Card title="API Reference" icon="link" href="https://library.ukg.com/ukg-pro">
  [https://library.ukg.com/ukg-pro](https://library.ukg.com/ukg-pro)
</Card>