Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Litmos credentials

Each setup method requires you to pass in credentials generated in Litmos. Gather these credentials before you move on.

A user with Account Owner or Administrator role in Litmos must perform this task.

Look up your Litmos API key

1. In Litmos, open your user profile menu and click My Profile & Settings.

2. Click API key.

3. Carefully and copy and save the API key.

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

Set up a Litmos cloud-hosted connector

To complete this task, you’ll need:

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

1. In ConductorOne, navigate to Admin > Connectors and click Add connector.

2. Search for Litmos and click Add.

3. Choose how to set up the new Litmos 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. Enter the name of your Litmos account in the Source field.

8. Paste the API key into the API key field.

9. Optional. In the Course IDs field, add the ID numbers of the courses you want to sync. If no course numbers are entered, ConductorOne will sync all available courses.

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 Litmos connector is now pulling access data into ConductorOne.

Set up a Litmos 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 Litmos and ConductorOne.

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

Set up a Litmos self-hosted connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in ConductorOne
• Access to the set of Litmos 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 Litmos connector

1. In ConductorOne, navigate to Connectors > Add connector.

2. Search for Baton and click Add.

3. Choose how to set up the new Litmos 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 Litmos connector deployment:

Secrets configuration

# baton-litmos-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-litmos-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Litmos credentials
  BATON_API_KEY: <Litmos API key>
  BATON_SOURCE: <Litmos account name>
  BATON_LIMITED_COURSES: <Litmos course ID numbers to sync (leave unspecified to sync all courses)>

  # Optional: include if you want ConductorOne to provision access using this connector
  BATON_PROVISIONING: true

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

Deployment configuration

# baton-litmos.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-litmos
  labels:
    app: baton-litmos
spec:
  selector:
    matchLabels:
      app: baton-litmos
  template:
    metadata:
      labels:
        app: baton-litmos
        baton: true
        baton-app: litmos
    spec:
      containers:
      - name: baton-litmos
        image: ghcr.io/conductorone/baton-litmos:latest
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-litmos-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-litmos-secrets.yaml
   

3. Apply the deployment:

   kubectl -n conductorone apply -f baton-litmos.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-litmos}
   

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 Litmos connector to. Litmos data should be found on the Entitlements and Accounts tabs.

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