Enabling SSO Login via Auth0

This guide explains how to enable Single Sign-On (SSO) login via Auth0 in Open Loyalty.

Prerequisites

1. Obtain the following information from the Auth0 application:

   • Domain (e.g. https://......auth0.com/)

   • Client ID

2. Ensure that the email address you want to use for SSO login does not already exist in the Open Loyalty portal.

If an email address for the admin already exists in Open Loyalty, the SSO login will not function for that account. To enable SSO for a user, ensure there are no conflicts.

For instance, you could deactivate admin users logging in with email and password, update their email addresses by adding a suffix (e.g., "-old"), and then ask the admin users to log in via SSO.

Step-by-Step Configuration

1

Obtain Auth0 Application Details

Since the exact setup of the Auth0 application may vary depending on the client’s implementation, you will need to retrieve the following details from the client or the Auth0 administrator:

1. Domain

2. Client ID

If the client does not have these details or is unsure about their Auth0 setup, they should consult their Auth0 documentation or contact Auth0 support for assistance.

2

Share Auth0 Details with Open Loyalty

• Provide the Domain and Client ID to the Open Loyalty team.

• The Open Loyalty team will enable SSO using the provided details.

3

Configure the Default Role

1. Log in to the Open Loyalty admin panel.

2. Go to Settings > Roles.

3. Choose the role you want to set as a default role. Click on Edit.

4. Set a Default Role for new users logging in through SSO. This role will be assigned to newly created users and can be changed later if needed.

4

Test the Integration

1. Use the Continue with Auth0 button on the login page.

2. Authenticate with Auth0 using a user account.

3. Verify that the user is successfully logged in and has been assigned the default role.

Notes

• Ensure that the Default Role is configured appropriately to avoid granting unintended permissions to new users.

• If an email address already exists in Open Loyalty, the SSO login will not work for that account. Ensure there are no conflicts before enabling SSO for a user.

Troubleshooting

• If login fails, double-check the Domain and Client ID configuration.

• Ensure the callback URL is correctly set in Auth0.

• Verify that the Auth0 application has been configured to allow the Open Loyalty URL.

By following these steps, you can enable SSO login via Auth0, streamlining the authentication process for your users.