Class LoginAttemptInformation

A simple class to represent a Login Attempt.

Hierarchy

FrameworkObject
- LoginAttemptInformation

Index

Constructors

Accessors

failReason isSuccessful jwt userInformation

Constructors

`Protected`constructor

new LoginAttemptInformation(isInternalConstructor?): LoginAttemptInformation
Parameters
- OptionalisInternalConstructor: boolean
Returns LoginAttemptInformation
Overrides FrameworkObject.constructor

Accessors

failReason

get failReason(): string
A string that describes the login failure reason.

Returns string

isSuccessful

get isSuccessful(): boolean
Indicates if the login was successful or not.

Returns boolean

jwt

get jwt(): string
The user JWT token. Required for API authenticated requests.

Returns string

userInformation

get userInformation(): CloudUserInformation
The currently logged in user information.

Returns CloudUserInformation