Skip to main content

foundation-comms.auth

Home > @genesislcap/foundation-comms > Auth

Auth interface​

Auth is the main interface for authenticating with a Genesis Server endpoint.

Signature:

export interface Auth 

Properties​

Property

Modifiers

Type

Description

isLoggedIn

readonly

boolean

A boolean value indicating whether or not the user is currently logged in.

isLoggedIn$?

readonly

Observable<boolean>

(Optional) An Observable that emits a boolean value indicating whether or not the user is currently logged in.

isWorking

boolean

Indicates whether Auth is working or is idle.

Methods​

Method

Description

login(credentials)

Logs in the user with the specified credentials.

logout()

Logs out the current user, if any.

reAuthFromSession()

Attempts to re-authenticate the user using the existing session data.