Set up a Keycloak connector

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

Capabilities

Resource	Sync	Provision
Accounts	✅
Groups	✅	✅

Gather Keycloak credentials

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

A user with admin access to the Keycloak realm you’re integrating with ConductorOne (specifically, the user must have the manage-clients role) must perform this task.

Create a Keycloak client

In the Keycloak Admin Console, navigate to Clients.
Make sure you’re in the correct realm, then click Create client.
Choose a Client ID for the client. Save this ID, as we’ll use it during the connector setup process.
Fill out the rest of the client registration form. Make sure to enable Client authentication.
Save your client configuration.
On the new client’s Credentials tab, carefully copy and save the Client secret.
Finally, make a note of your Keycloak realm and server URL.

That’s it! Next, move on to the connector configuration instructions.

Configure the Keycloak connector

To complete this task, you’ll need:
The Connector Administrator or Super Administrator role in ConductorOne
Access to the set of Keycloak credentials generated by following the instructions above

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

In ConductorOne, navigate to Admin > Connectors and click Add connector.
Search for Keycloak and click Add.
Choose how to set up the new Keycloak 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
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.
Click Next.
Find the Settings area of the page and click Edit.
Paste the Keycloak credentials you gathered into the relevant fields.
Click Save.
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 Keycloak connector is now pulling access data into ConductorOne.

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

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.

Step 1: Set up a new Keycloak connector

In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new Keycloak 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
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.
Click Next.
In the Settings area of the page, click Edit.
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 Keycloak connector deployment:

Secrets configuration

# baton-keycloak-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-keycloak-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Keycloak credentials
  BATON_KEYCLOAK_CLIENT_ID: <Keycloak client ID>
  BATON_KEYCLOAK_CLIENT_SECRET: <Keycloak client secret>
  BATON_KEYCLOAK_REALM: <Realm of the Keycloak server>
  BATON_KEYCLOAK_SERVER_URL: <Keycloak server URL (defaults to https://keycloak.com/)>

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

Step 3: Deploy the connector

Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.
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 Keycloak connector to. Keycloak data should be found on the Entitlements and Accounts tabs.

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