Skip to main content

Microsoft Entra ID Module

Introduction​

This module enables customers to authenticate in the LoyJoy chat agent using their Microsoft Entra ID (formerly known as Azure Active Directory) account through OAuth 2.0.

Typical Use Cases​

Use this module to securely authenticate users in the chat, retrieve user details from Microsoft Entra ID, and tailor the chat agent based on their profile information.

How to Use the Module​

  1. Configure Redirect URIs: Add the following redirect URIs to your Microsoft Entra ID 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 ensure that users are properly redirected back to the chat after authentication.

  1. Enter Microsoft Entra ID Credentials: In the LoyJoy module, input your:
  • Tenant ID
  • Client ID
  • Client Secret
  • Scope

These details authenticate users and manage their sessions securely.

  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 Microsoft, however you can request additional fields by adding them as source to mappings:

businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName

These fields are documented in Microsoft Graph REST API documentation.