Skip to content
Bexxo Help

Help The platform Import and SSO

Connect Keycloak

For administrators Updated on 13 November 2026

Connect a Keycloak realm to synchronize the people and groups of the organization, and prepare sign-in with the Keycloak account (SSO).
On this page
  1. Overview
  2. Prepare a client in Keycloak
  3. Fill in the Connection section
  4. What is imported
  5. SSO sign-in with Keycloak
  6. Test and troubleshoot

Overview

Keycloak is read in read-only mode: users, groups (including subgroups) and members of a realm. This article covers the preparation in Keycloak and the Connection and SSO sign-in sections; the other settings are common to all imports.

The settings common to all importsImport people and set up SSO

1Prepare a client in Keycloak

The synchronization authenticates as a confidential client with a service account (client_credentials flow). In the realm to be read:

  1. create an OpenID Connect client with client authentication and service account enabled;

  2. assign to its service account the two roles below from the realm-management client;

  3. check that the realm answers at {base URL}/realms/{realm}/protocol/openid-connect/token (token) and {base URL}/admin/realms/{realm}/ (reads).

Roles from the realm-management client

Without client-side encryption, our servers connect to Keycloak from the internet: the address must use https:// and resolve only to public addresses. In an encrypted organization, the Bexxo Protected agent reads Keycloak from your network.

2Fill in the Connection section

Enter the realm, the client ID and secret, and the Base URL: the server address in https://, without /realms, for example https://sso.exemple.ch. If your server publishes its realms under a path (such as /auth), include it.

What is imported

  • A user disabled in Keycloak is imported as inactive.
  • Each subgroup, at any depth, becomes a group. Only direct members are attached: a member of a subgroup is not attached to the parent group.
  • Properties usable in the field matching and the filters, for a person: username, email, firstName, lastName, enabled, and each custom attribute in the form attributes. followed by its name (first value only), for example attributes.department.
  • For a group: name and path (full path, for example /Siège/Vente).

The prefilled matching only covers the last name, the first name and the email: if needed, add a line for the job title or the phone from a custom attribute.

SSO sign-in with Keycloak

SSO uses an OpenID Connect client of the realm, with its own client ID and secret, independent of the Connection section.

  1. Declare all the redirect URLs shown in SSO sign-in (portal and Academy) as valid redirect URIs of the client.

  2. Enter the realm issuer, of the form https://{server}/realms/{realm}, the client ID and secret, save, then test discovery. The issuer must be reachable from the internet, even for an organization with active encryption.

Enabling SSO and the effects of an outage are described in the general article.

Test and troubleshoot

SituationWhat to check
Connection test failureIs the base URL in https://, without /realms? Are the realm and the client ID correct? Is the service account enabled on the client?
Credentials accepted, read refusedDoes the client’s service account have the view-users and query-groups roles from the realm-management client?
Organization with active encryptionThe test and the synchronization go through the Bexxo Protected agent: it must be started and reach your Keycloak server.
Organization with active encryptionInstall the Bexxo Protected agent

Didn’t find the answer? Contact us