Skip to main content

Auth0 Module

This module allows customers to authenticate in the chat using an Auth0 user account based on OAuth 2.0. Simply provide the credentials from Auth0 to identify your customers within the chat. This enables seamless user identification and interaction within the chat.

Typical Use Cases​

Use this module to authenticate users securely in the chat through Auth0, retrieve user information, and customize user experiences based on their profile data.

How to Use the Module​

  1. Configure Redirect URIs: Set up the following redirect URIs in your Auth0 application 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 are essential to guide users back to the chat post-authentication while maintaining security.

  1. Enter Auth0 Credentials: In the LoyJoy module, input your:
  • Auth0 Domain
  • Client ID
  • Client Secret
  • Scope

These credentials will authenticate users and allow you to manage user sessions.

  1. Customize Texts: Adjust the text for the sign-in button and login prompts under "Other Texts" in the LoyJoy platform to match your branding.

Mappings​

Configure source fields in mappings to retrieve user profile information. Default fields provided by Auth0 include:

birthdate, family_name, email, email_verified, gender, given_name, locale, middle_name, name, nickname, phone_number, phone_number_verified, picture, preferred_username, profile, sub, website, zoneinfo

These fields are documented in Auth0 Normalized User Profile Schema documentation.