Set up a UKG connector

C1 provides identity governance for UKG. Integrate your UKG instance with C1 to run user access reviews (UARs) and enable just-in-time access requests.

Capabilities

Resource	Sync	Provision
Accounts
Roles

An employee in UKG Pro can have one employment record per company they’ve ever been assigned to (for example, a stale record at a former or vendor company alongside a current record at their real employer). C1 considers an account enabled if any of the employee’s employment records is non-terminated, not just their most recent or first-listed one — an employee who is active at one company is synced as enabled even if they also have older, terminated records at other companies.

Gather UKG credentials

Configuring the connector requires you to pass in credentials generated in UKG. Gather these credentials before you move on.

A user with the permission to create a service account in UKG Pro must perform this task.

Look up your UKG customer API key

1. Log into UKG Pro and navigate to the Service Account Administration page by using the search bar.

2. Locate the Customer API Key at the top of this page. Carefully save this API key.

Create a service account

1. Still on the Service Account Administration page, click Add to create a new service account.

2. Give the new service account a name such as “C1 integration” and enter the email address you want to associate with the account.

3. Click to enable the Generate New Password checkbox.

4. Give the service account the View role on the following web services:

   • Employee Export — required to sync accounts (GET /personnel/v1/employee-changes)
   • Personnel Integration — required to sync accounts and roles (GET /personnel/v1/employment-details, GET /personnel/v1/user-profile-details)
   • Company Configuration Integration — required to sync roles (GET /configuration/v1/roles)
   • Employee Person Details (optional — required only if you enable the connector’s Include Person Details on Sync setting, to sync preferred name and alternate email onto account profiles) (GET /personnel/v1/person-details/{employeeId})
5. Scroll to the top of the page and click Save.

6. A new password is generated for the service account. Make a careful note of this password.

Locate your service endpoint

1. Use the UKG search bar to navigate to the Web Services page.

   The list of web services for your UKG instance are formed like https://example.ultipro.com/services/endpoint-name. Carefully copy the scheme (https://) and domain name (example.ultipro.com) but do not include the subdirectory path (which begins with /services in our example). In our example, you’d copy http://example.ultipro.com. This is your service endpoint.

2. Save the service endpoint.

Done. Next, move on to the connector configuration instructions.

Configure the UKG connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in C1
• Access to the set of UKG credentials generated by following the instructions above

Cloud-hosted

Follow these instructions to use a built-in, no-code connector hosted by C1.

1. In C1, navigate to Integrations > Connectors and click Add connector.

2. Search for UKG and click Add.

3. Choose how to set up the new UKG connector:

   • Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with C1)

   • Add the connector to a managed app (select from the list of existing managed apps)

   • Create a new managed app

4. Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.

   If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.

5. Click Next.

6. Find the Settings area of the page and click Edit.

7. In the Customer API key fields, enter the API key.

8. In the Username and Password fields, enter the username and password for the service account.

9. In the Service endpoint field, enter the service endpoint.

10. Click Save.

11. The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

Done. Your UKG connector is now pulling access data into C1.

Self-hosted

Follow these instructions to use the UKG connector, hosted and run in your own environment.

When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

Resources

Contact C1’s support team to download the latest version of the connector.

Step 1: Set up a new UKG connector

1. In C1, navigate to Integrations > Connectors > Add connector.

2. Search for Baton and click Add.

3. Choose how to set up the new UKG connector:

   • Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with C1)

   • Add the connector to a managed app (select from the list of existing managed apps)

   • Create a new managed app

4. Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.

   If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.

5. Click Next.

6. In the Settings area of the page, click Edit.

7. Click Rotate to generate a new Client ID and Secret.

   Carefully copy and save these credentials. We’ll use them in Step 2.

Step 2: Create Kubernetes configuration files

Create two Kubernetes manifest files for your UKG connector deployment:

Secrets configuration

# baton-ukg-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-ukg-secrets
type: Opaque
stringData:
  # C1 credentials
  BATON_CLIENT_ID: <C1 client ID>
  BATON_CLIENT_SECRET: <C1 client secret>
  
  # UKG credentials
  BATON_CUSTOMER_API_KEY: <UKG API key>
  BATON_SERVICE_ENDPOINT: <UKG service endpoint>
  BATON_PASSWORD: <Password for the UKG account>
  BATON_USERNAME: <Username for the UKG account>

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# baton-ukg.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-ukg
  labels:
    app: baton-ukg
spec:
  selector:
    matchLabels:
      app: baton-ukg
  template:
    metadata:
      labels:
        app: baton-ukg
        baton: true
        baton-app: ukg
    spec:
      containers:
      - name: baton-ukg
        image: public.ecr.aws/conductorone/baton-ukg:latest
        imagePullPolicy: IfNotPresent
        env:
        - name: BATON_HOST_ID
          value: baton-ukg
        envFrom:
        - secretRef:
            name: baton-ukg-secrets

Step 3: Deploy the connector

1. Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.

2. Check that the connector data uploaded correctly. In C1, click Apps. On the Managed apps tab, locate and click the name of the application you added the UKG connector to. UKG data should be found on the Entitlements and Accounts tabs.

Done. Your UKG connector is now pulling access data into C1.