For the complete documentation index, see llms.txt. This page is also available as Markdown.

User App

Overview

The User Module handles the user authentication process, including signup, sign-in, OTP verification, and redirection to appropriate screens based on user actions and authentication status. This module also manages tenant information fetched from the host app.

User Module

Components

  1. Signup: Handles new user registration.

  2. Enter OTP: Manages OTP entry for verification.

  3. Successful Signup: Confirmation screen after successful signup.

  4. SignIn: Manages user login.

  5. Home Screen: Displays after successful sign-in or signup.

  6. App Home Screen: Main application screen for authenticated users.

Flow

  1. Signup Process:

    • The user enters signup details.

    • On form submission, the user is redirected to the OTP entry screen.

  2. OTP Verification:

    • The user enters OTP.

    • On successful OTP verification, the user is redirected to the successful signup screen.

  3. SignIn Process:

    • The user enters login credentials.

    • On form submission, the user is redirected to the OTP entry screen for verification.

  4. Post Authentication:

    • After successful signup or sign-in, the user is redirected to the home screen.

    • The home screen displays the setup for the sandbox app drawer and a help/tutorial video based on BFF (Backend for Frontend) response.

  5. Main Application:

    • Fetches application states from BFF.

    • Redirects authenticated users to the app home screen.

Web API sequence Diagrams

The following screens based on the default Tenant

SIgn Up Flow
OTP Screen

Response screen will have the Client Sandbox Admin Portal Link

The following screens based on the Account/Client Tenant

SignIn
OTP Screen
Sandbox Home

Last updated

Was this helpful?