> ## 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 Ready (OAuth Client Credentials)

> Follow these steps to connect UKG Ready (OAuth Client Credentials) with StackOne Hub successfully.

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

If you've been directed to StackOne to integrate with UKG Ready (OAuth Client Credentials), the following steps will help you understand the process and any necessary actions to configure successful integration.

## Getting your UKG Ready URL and Company Short Name

<Steps>
  <Step title="Login to UKG Ready dashboard">
    Once logged in, copy your **UKG Ready URL** from the address bar, ending with `.rdy.ukg.dev`. Store this to be used in a later step.

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

  <Step title="Navigate to Company Setup">
    Click `≡` at the top-left corner.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Company Setup" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image1.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=577a5f73db45c3a55ed775f4255cd568" width="434" height="160" data-path="images/ukgready/image1.png" />
    </Frame>

    Navigate to `Settings` > `Global Setup`

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="global setup" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image2.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=37c3ecc0a0bdeb42adde6d22447b9d0e" width="802" height="1160" data-path="images/ukgready/image2.png" />
    </Frame>

    then `Global Setup` > `Company Setup`

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

  <Step title="Copy Company Short Name">
    Under `Company Setup` > `Company Info`, scroll down to the Company Address
    section and copy the Company Short Name. If it is not available in that
    section, please enter the Company Short Name and click `Save`

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Company info" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image4.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=7309a3dc67b0670f83b5676ba6da6ae5" width="2390" height="456" data-path="images/ukgready/image4.png" />
    </Frame>

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Company Short Name" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image5.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=025dac9064bba01d2d1f93bdd116f0fc" width="3450" height="1074" data-path="images/ukgready/image5.png" />
    </Frame>
  </Step>
</Steps>

## Enabling OAuth Applications in your dashboard

<Steps>
  <Step title="Enable OAuth Applications">
    The option to generate OAuth credentials may not be available by default, and must be enabled to support this connection.
    Under *Company Setup* Navigate to `Edit Tabs`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="edit tabs tab" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image7.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=4e4bf63b5d56fd7926939d6f11bf6c59" width="1992" height="378" data-path="images/ukgready/image7.png" />
    </Frame>

    If you don't already see `OAuth Applications` in the column view - then from
    the `Available Windows` section look for `OAuth Applications`

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="edit tabs tab" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image8.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=0757ddb9d7ec2f800072d51012f6f43b" width="3404" height="1546" data-path="images/ukgready/image8.png" />
    </Frame>

    Drag it into a column of your choice under the `Login Config` tab.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="edit tabs tab" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image10.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=0a10e871e2398024452c63fb1899b5b0" width="2684" height="1142" data-path="images/ukgready/image10.png" />
    </Frame>

    Once you're happy with the view - click `Save` and navigate back to the `Company Setup` view.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="edit tabs tab" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image11.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=320521c1222623f66b8e9d3c75e0fa8c" width="3374" height="374" data-path="images/ukgready/image11.png" />
    </Frame>
  </Step>
</Steps>

## Generating OAuth Client Credentials

<Steps>
  <Step title="Add OAuth Application">
    Under *Company Setup* on the `Login Config` tab,

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="login config" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image12.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=b2a540b8135fcae89acd4647b3b989d9" width="1992" height="378" data-path="images/ukgready/image12.png" />
    </Frame>

    Find `OAuth Applications` and click `Add OAuth Application`

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="OAuth Application" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image13.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=332225077b73341dd818617211e8daaf" width="1492" height="366" data-path="images/ukgready/image13.png" />
    </Frame>
  </Step>

  <Step title="Generate OAuth Client Credentials">
    Enter the following field values:

    * **Name:** Enter a name for this new OAuth application
    * **Application Type:** Select `Machine to Machine`
    * **Client Id:** Generated Automatically
    * **Secret:** Click on the `GENERATE SECRET` button
    * **Security Profile:** Select a Security Profile within your UKG Ready instance that has permissions for all of the data you wish for this integration to read and/or modify.
    * **Account Groups:** Click on the `List Group` icon to select one of the groups that has been assigned the required permissions.
      * Select the "System" group type called "All Company Employees" (this is a built-in, non-editable group that includes all company employees).

            <Frame>
              <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Account Groups - System Group Selection" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/22.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=815c9b5ab72f54a3ae114fc63a0f7e4c" width="933" height="97" data-path="images/ukgready/22.png" />
            </Frame>

    <Accordion title="Permissions required within the Security Profile">
      <Steps>
        <Step title="Create Security Profile">
          Click `≡` at the top-left corner.

          <Frame>
            <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Company Setup" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image1.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=577a5f73db45c3a55ed775f4255cd568" width="434" height="160" data-path="images/ukgready/image1.png" />
          </Frame>

          Navigate to the `Profiles/Policies` > `Security`, then click on `NEW SECURITY PROFILE` to create one,

          <Frame>
            <img className="rounded-md" style={{ margin: "0 auto",border: "1px solid #efefef" }} alt="new scurity profile" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/new_security_profile_1.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=8c2f0606729d9b08584a2c32f26b2feb" width="1294" height="101" data-path="images/ukgready/new_security_profile_1.png" />
          </Frame>

          Enter the `Name`, `Description` (optional) and check `Active` field, then click on `Save` button.

          <Frame>
            <img className="rounded-md" style={{ margin: "0 auto",border: "1px solid #efefef" }} alt="new scurity profile form" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/new_security_policy_form_2.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=86e376e3ab645dc7dbbcf9a463900cad" width="622" height="300" data-path="images/ukgready/new_security_policy_form_2.png" />
          </Frame>
        </Step>

        <Step title="Add/Edit Required Permissions to Security Profile">
          Under the `Security Items`, Navigate to following tabs to mark the permissions:

          `Global` tab

          * Global Setup
            * Cost Center Definitions (View/Edit/Add)
            * Cost Center Trees (View/Edit)

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

          * Object Lists
            * Cost Centers (View/Edit/Add)

          <Frame>
            <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="object_list_1" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/object_list_1.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=48f135801477e83f0e7bda70f55261f4" width="340" height="276" data-path="images/ukgready/object_list_1.png" />
          </Frame>

          `HR` tab

          * Employee Management
            * Base Compensation (View/Edit)
            * Benefit Management (Plans) (View/Edit)
            * Cost Centers (View/Edit)
            * Demographics (View/Edit)
            * HR Custom Values (View/Edit)

          <Frame>
            <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="employee_manag_1" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/employee_manag_1.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=6e7aec218459b7fc97077c4cdc385dcc" width="499" height="525" data-path="images/ukgready/employee_manag_1.png" />
          </Frame>

          * Position Management
            * Positions (View/Edit/Add)

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

          `Modules` tab

          * REST API Resources
            * Employee Demographics (View/Edit)
            * Employee HR Custom Fields (View/Edit)
            * Employee Pay Information (View/Edit)
            * Employee Profiles (View/Edit)
            * Employees (View/Edit/Add)
            * Employees (Changed) (View)

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

        <Step title="Save Security Profile">
          Click on `Save` to save security profile changes,

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

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="login config" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image-20.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=29e3dac7f6c6b87690c1425efa6c9cd7" width="795" height="709" data-path="images/ukgready/image-20.png" />
    </Frame>

    Click on the `List Security Profile` icon. Your added security profile will be displayed in the Security Profiles Lookup grid for selection. Click on the `🏳️` icon to choose it.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="security_profiles_lookup" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/security_profiles_lookup.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=5b154e7b8dfee83fd11afc48e0eb9803" width="773" height="449" data-path="images/ukgready/security_profiles_lookup.png" />
    </Frame>

    Once you're happy with the configuration - click the `Save` button.
  </Step>
</Steps>

## Job Change Reason Codes

<Info>
  UKG Ready (OAuth Client Credentials) requires a Job Change Reason Code when assigning a job to a new hire or changing an employee's job. At least one of these fields is required if employee jobs will be assigned via this connection.
</Info>

<Steps>
  <Step title="Navigate to Job Change Reason Code">
    Click `≡` at the top-left corner.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Company Setup" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image1.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=577a5f73db45c3a55ed775f4255cd568" width="434" height="160" data-path="images/ukgready/image1.png" />
    </Frame>

    Navigate to `Settings > HR Setup > Company Setup > Job Change Reason Codes`

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="global setup" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image16.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=8e7e8aca3442376bd992e2456bfa730b" width="806" height="1632" data-path="images/ukgready/image16.png" />
    </Frame>
  </Step>

  <Step title="Copy Job Change Reason Code">
    The existing codes for your company will be displayed here. For the following fields on the connector hub form,

    * **Job Change Reason Code - Employee Create** field, we recommend using a code of Type `New Hire`.
    * **Job Change Reason Code - Employee Update** field, we recommend using a code of Type `Other`.

    You can create a new code by clicking the `ADD NEW` button in the top-right.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="global setup" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image-18.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=e1dd1081572cf632fe31ea5a36d7f865" width="1240" height="279" data-path="images/ukgready/image-18.png" />
    </Frame>

    Copy the **Name** of each code you wish to use.
  </Step>
</Steps>

## Connecting with StackOne

<Steps>
  <Step title="Connecting with StackOne">
    Upon reaching the Link Account page, enter the following credentials:

    * UKG Ready URL
    * Client ID
    * Client Secret
    * Company Short Name
    * Job Change Reason Code - Employee Create (optional)
    * Job Change Reason Code - Employee Update (optional)

    Proceed by clicking the `Connect` button.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Enter Credentials" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/_BEMwWcX5HRLBXL3/images/ukgready/image-21.png?fit=max&auto=format&n=_BEMwWcX5HRLBXL3&q=85&s=fcd9295452e36c622948fba6ed27c6bf" width="483" height="772" data-path="images/ukgready/image-21.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-ready">
  [https://library.ukg.com/ukg-ready](https://library.ukg.com/ukg-ready)
</Card>
