Skip to main content

Keycloak Module

Introduction​

This module enables customers to authenticate in the chat using their Keycloak account through OAuth 2.0.

Typical Use Cases​

Use this module to securely authenticate users in the chat, retrieve user details from Keycloak, and tailor the chat experience based on their profile information.

How to Use the Module​

  1. Configure Redirect URIs: Add the following redirect URIs to your Keycloak settings:
  • https://app-stable.loyjoy.com/auth/oauth2/callback
  • https://app-runtime.loyjoy.com/auth/oauth2/callback
  • https://runtime.loyjoy.com/auth/oauth2/callback

These URIs ensure that users are properly redirected back to the chat after authentication.

  1. Enter Keycloak Credentials: In the LoyJoy module, input your:
  • Keycloak URL
  • Client ID
  • Client Secret
  • Scope
  1. Customize Texts: Adjust the text for the sign-in button and login prompts under "Other Texts" in the LoyJoy platform to match your desired messaging.

Mappings​

In the mappings you can configure source fields to read from. The following source fields are provided by default by Keycloak, however you can request additional fields by adding them as source to mappings:

firstName, id, lastName, username