project.md

lib_UserManager_ui_ngx

The lib_UserManager enables your projects to include user management and authentication in your apps. This library will handle :

• user login with user/password using a salted password security
• user login using OpenID

References

lib_OAuth

lib_OAuth

see readme

lib_UserManager

lib_UserManager

see readme

Connectors

void

void connector, replace or don't use it

Transactions

void

does nothing

Sequences

GetSymbols

Variables

name	comment
metadata

Mobile Application

MobileApplication

Pages

ConfirmAccountPage

ConfirmAccountPage

DeleteAccountPage

DeleteAccountPage

ForgotPasswordPage

ForgotPasswordPage

ModalPopup

ModalPopup

Page

Page

Shared Actions

guardPages : Handles access control and redirection based on the user's authentication status and the page they are attempting to access

guardPages

Handles access control and redirection based on the user's authentication status and the page they are attempting to access.

This shared action should be invoked from an AppGuard component.

Behavior:

• If the user is not authenticated and tries to access a page listed in authorizedPagesOnlyWithAuthentication, they will be redirected to unauthenticatedAccessRedirectPage.
• If the user is authenticated and tries to access a page listed in authorizedPagesOnlyWithoutAuthentication, they will be redirected to authenticatedAccessRedirectPage.
• If the current page is not restricted based on the user's authentication status, no redirection occurs.

Variables

name	comment
authenticatedAccessRedirectPage	Type: String | Specifies the page to redirect users to when they attempt to access a page that should not be accessible after they have already logged in (e.g., login or registration pages).
authorizedPagesOnlyWithAuthentication	Type: Array of String | Specifies the list of pages that are only accessible to authenticated users. These pages should not be available to users who are not logged in (e.g., dashboard or profile pages).
authorizedPagesOnlyWithoutAuthentication	Type: Array of String | Specifies the list of pages that are only accessible to users who are **not** authenticated. These pages should be hidden or restricted once the user is logged in (e.g., login or registration pages).
unauthenticatedAccessRedirectPage	Type: String | Specifies the page to redirect users to when they attempt to access a restricted page without being authenticated. (e.g., dashboard or profile pages).

isAuthenticatedSession : Returns true if current session is authenticated

isAuthenticatedSession

Returns true if current session is authenticated

SignIn : The `SignIn` function handles user authentication and remember me feature

SignIn

The SignIn function handles user authentication and remember me feature

Variables

name	comment
password	The user's password
rememberMe	Stay logged in for an extended period, even after closing the browser
user	The userID (user's email)

SignOut : The `SignOut` function handles user signout and remember me feature

SignOut

The SignOut function handles user signout and remember me feature

Shared Components

ConfirmAccount

ConfirmAccount

Variables

name	comment
appName
imgUrl
resetKey

Events

name	comment
PasswordChangedError
PasswordChangedOk

DeleteAccount

DeleteAccount

Variables

name	comment
appName
imgUrl
moretext
resetKey

Events

name	comment
PasswordChangedError
PasswordChangedOk

ForgotPassword

ForgotPassword

Variables

name	comment
appName
imgUrl
resetKey

Events

name	comment
PasswordChangedError
PasswordChangedOk

LoginComponent : This component handle a login / password form

LoginComponent

This component handle a login / password form. And uses the lib_UserManager

The component will check user / password and if successful will autenticate the user. When the user is authenticated, the component will fire a 'login' event that you can handle with a SubscribeHandler. use this event to close a modal page or to push/root a new page when the user is authenticated

Variables

name	comment
enableAzureADLogin	Set to false to disable login with AzureAD
enableCancelDismiss	Set to true if you want a cancel button to be displayed causing a Modal Page dismiss
enableGoogleLogin	Set to false to disable loggin with google
enableLinkedInLogin	Set to false to disable login with LinkedIn
logoImage	A logo image to be displayed over the login form (64x64)
logoWidth
scope	Additional Scope to be added to the standard Scope. This will be concatenated to to the scopr string. For Azure AD start with a + sign
tenantid	The tenant ID you want to restrict to, leave blank for no tenant.

Events

name	comment
login	This event will be fired when a login occurs : Check out.error and out.message for login errors The out.user will be user logged in