Configure Keycloak for Xeditor

Introduction

With Keycloak 25, the session_state JWT claim has been removed. Instead, the value is placed in the sid attribute. For more information, see Keycloak documentation.

The session_state claim can be added via an additional mapper in the Keycloak Client scopes definition.

Add “Client Scope” to Keycloak

If you are using Keycloak 25 or higher, check if the basic Client scope contains the session_state mapper:

  1. Open Keycloak and open the realm which is configured to use with Censhare.

  2. Open Client scopes entry in the left navigation:

    desktop-app with basic client scope.png
  3. Open the basic Client scope.

  4. Switch to the Mappers tab.

  5. Check if the session_state mapper exists:

    Keacloak_add_session-state_mapper.png

If not, add it:

  1. Click Add mapper.

  2. Select By configuration.

  3. A table opens: click the Session State (session_state) entry.

  4. For the Name, enter session_state:

    Keacloak_add_session-state_mapper.png
  5. Click Save.