Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather UKG credentials

Each setup method 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, we’ll use it in Step 4.

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 “ConductorOne 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
   • Personnel Integration
   • Company Configuration Integration

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, we’ll use it in Step 4 along with the service account’s username.

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.

That’s it! Next, move on to the instructions for your chosen setup method.

Set up a UKG cloud-hosted connector

To complete this task, you’ll need:

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

1. In ConductorOne, navigate to Admin > 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 ConductorOne)

   • 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 ConductorOne users. Setting multiple owners is allowed.

   If you choose someone else, ConductorOne 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.

That’s it! Your UKG connector is now pulling access data into ConductorOne.

Set up a UKG cloud-hosted connector using Terraform

As an alternative to the cloud-hosted setup process described above, you can use Terraform to configure the integration between UKG and ConductorOne.

See the ConductorOne UKG integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.

Set up a UKG self-hosted connector

To complete this task, you’ll need:

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

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

Why use Kubernetes? Kubernetes provides automated deployment, scaling, and management of your connectors. It ensures high availability and reliable operation of your connector services.

Step 1: Configure the UKG connector

1. In ConductorOne, navigate to 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 ConductorOne)

   • 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 ConductorOne users. Setting multiple owners is allowed.

   If you choose someone else, ConductorOne 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:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne 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: ghcr.io/conductorone/baton-ukg:latest
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-ukg-secrets

Step 3: Deploy the connector

1. Create a namespace in which to run ConductorOne connectors (if desired):

   kubectl create namespace conductorone
   

2. Apply the secret configuration:

   kubectl -n conductorone apply -f baton-ukg-secrets.yaml
   

3. Apply the deployment:

   kubectl -n conductorone apply -f baton-ukg.yaml
   

Step 4: Verify the deployment

1. Check that the deployment is running:

   kubectl -n conductorone get pods
   

2. View the connector logs:

   kubectl -n conductorone logs -l app=baton-${baton-ukg}
   

3. Check that the connector data uploaded correctly. In ConductorOne, click Applications. 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.

That’s it! Your UKG connector is now pulling access data into ConductorOne.