Authenticate Users Using Hubtel's Backoffice

IN SUMMARY

To authenticate users using the backoffice, register your app in the Auth backoffice with the lookup url, and use the generated app ID for the frontend integration. Follow the Frontend Integration guide.

Introduction

This guide explains how to authenticate users in your application based on their access defined in the the Hubtel's Internal Backoffice. This is ideal for projects where users are managed through the backoffice.

Prerequisites

• The app uses Email to authenticate users
• The users are registered in the backoffice or will be registered in the backoffice.
• The users have been assigned the necessary permissions. If you need help with setting up permissions, contact the Finance team.

Email Lookup Url

The lookup url is the endpoint that your app will use to verify the user's identity. It uses the backoffice app id and the users email to to verify them. The engineer is not required to create this endpoint, it is created by the Auth backoffice.

NOTE

The id in the lookup url is usually the prefix of the the names given to the the permissions assigned to the app. Example, the zone backoffice has permissions like zone.rider.read, zone.rider.create etc. The id in the lookup will be zone.

App Registration

After the above prerequisites have been met, you need to register your app from the Auth backoffice with the preferred settings together with the lookup url. This will generate the app id that will be used in the fronted integration. Refer to the Frontend Integration guide for more information on how to integrate the frontend app