Skip to main content

Abstract Class: BaseAuthOTPRouteSQL

Defined in: src/routes/sql/BaseAuthOTPRouteSQL.ts:8

Extends​

Constructors​

Constructor​

new BaseAuthOTPRouteSQL(): BaseAuthOTPRouteSQL

Returns​

BaseAuthOTPRouteSQL

Inherited from​

BaseAuthOTPRoute.constructor

Properties​

aliasClass​

protected aliasClass: any = AliasSQL

Defined in: src/routes/sql/BaseAuthOTPRouteSQL.ts:9

Overrides​

BaseAuthOTPRoute.aliasClass

aliasRepo?​

protected optional aliasRepo?: RepoUtils<AliasSQL>

Defined in: src/routes/BaseAuthOTPRoute.ts:40

Inherited from​

BaseAuthOTPRoute.aliasRepo

authMiddleware?​

protected optional authMiddleware?: AuthMiddleware

Defined in: src/routes/BaseAuthOTPRoute.ts:43

Inherited from​

BaseAuthOTPRoute.authMiddleware

defaultScopes​

protected defaultScopes: string[] = []

Defined in: src/routes/BaseAuthOTPRoute.ts:49

Inherited from​

BaseAuthOTPRoute.defaultScopes

jwtConfig?​

protected optional jwtConfig?: any

Defined in: src/routes/BaseAuthOTPRoute.ts:52

Inherited from​

BaseAuthOTPRoute.jwtConfig

logger​

protected logger: any

Defined in: src/routes/BaseAuthOTPRoute.ts:46

Inherited from​

BaseAuthOTPRoute.logger

messagingUtils?​

protected optional messagingUtils?: MessagingUtils

Defined in: src/routes/BaseAuthOTPRoute.ts:55

Inherited from​

BaseAuthOTPRoute.messagingUtils

rateLimiter?​

protected optional rateLimiter?: RateLimiter

Defined in: src/routes/BaseAuthOTPRoute.ts:58

Inherited from​

BaseAuthOTPRoute.rateLimiter

secretClass​

protected secretClass: any = SecretSQL

Defined in: src/routes/sql/BaseAuthOTPRouteSQL.ts:10

Overrides​

BaseAuthOTPRoute.secretClass

secretRepo?​

protected optional secretRepo?: RepoUtils<SecretSQL>

Defined in: src/routes/BaseAuthOTPRoute.ts:60

Inherited from​

BaseAuthOTPRoute.secretRepo

template​

protected template: string = "login-otp"

Defined in: src/routes/BaseAuthOTPRoute.ts:63

The name of the messaging template to use for sending notifications.

Inherited from​

BaseAuthOTPRoute.template

tokenUtils?​

protected optional tokenUtils?: TokenUtils

Defined in: src/routes/BaseAuthOTPRoute.ts:66

Inherited from​

BaseAuthOTPRoute.tokenUtils

userClass​

protected userClass: any = UserSQL

Defined in: src/routes/sql/BaseAuthOTPRouteSQL.ts:11

Overrides​

BaseAuthOTPRoute.userClass

userRepo?​

protected optional userRepo?: RepoUtils<UserSQL>

Defined in: src/routes/BaseAuthOTPRoute.ts:68

Inherited from​

BaseAuthOTPRoute.userRepo

userUtils?​

protected optional userUtils?: UserUtils<UserSQL, AliasSQL>

Defined in: src/routes/BaseAuthOTPRoute.ts:70

Inherited from​

BaseAuthOTPRoute.userUtils

Methods​

authenticate()​

authenticate(user, req, res): Promise<AuthResult | undefined>

Defined in: src/routes/BaseAuthOTPRoute.ts:137

Authenticates the user using OTP and returns a JSON Web Token access token to be used with future API requests.

Parameters​

user​

JWTUser

req​

HttpRequest

res​

HttpResponse

Returns​

Promise<AuthResult | undefined>

Inherited from​

BaseAuthOTPRoute.authenticate

convertAliasType()​

protected convertAliasType(type): OTPContactType

Defined in: src/routes/BaseAuthOTPRoute.ts:145

Parameters​

type​

AliasType

Returns​

OTPContactType

Inherited from​

BaseAuthOTPRoute.convertAliasType

getContact()​

protected getContact(id): Promise<OTPContact | undefined>

Defined in: src/routes/BaseAuthOTPRoute.ts:161

Retrieves the alias with the given unique id.

Parameters​

id​

string

The unique id of the alias to retrieve.

Returns​

Promise<OTPContact | undefined>

The alias if found, otherwise undefined.

Inherited from​

BaseAuthOTPRoute.getContact

getContacts()​

protected getContacts(id): Promise<OTPContact[]>

Defined in: src/routes/BaseAuthOTPRoute.ts:184

Retrieves all aliases for the user with the given id.

Parameters​

id​

string

The unique id of the user to lookup.

Returns​

Promise<OTPContact[]>

Inherited from​

BaseAuthOTPRoute.getContacts

getUser()​

protected getUser(uid): Promise<JWTUser | undefined>

Defined in: src/routes/BaseAuthOTPRoute.ts:228

Retrieves the user with the given unique id.

Parameters​

uid​

string

The unique id of the user to retrieve.

Returns​

Promise<JWTUser | undefined>

The user if found, otherwise undefined.

Inherited from​

BaseAuthOTPRoute.getUser

initialize()​

protected initialize(): Promise<void>

Defined in: src/routes/BaseAuthOTPRoute.ts:76

Called on server startup to initialize the route with any defaults.

Returns​

Promise<void>

Inherited from​

BaseAuthOTPRoute.initialize

notifyContact()​

protected notifyContact(contact, totp): Promise<void>

Defined in: src/routes/BaseAuthOTPRoute.ts:235

Parameters​

contact​

OTPContact

totp​

string

Returns​

Promise<void>

Inherited from​

BaseAuthOTPRoute.notifyContact