Skip to main content

Abstract Class: BaseAuthBasicRouteSQL

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

Extends​

Constructors​

Constructor​

new BaseAuthBasicRouteSQL(): BaseAuthBasicRouteSQL

Returns​

BaseAuthBasicRouteSQL

Inherited from​

BaseAuthBasicRoute.constructor

Properties​

aliasClass​

protected aliasClass: any = AliasSQL

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

Overrides​

BaseAuthBasicRoute.aliasClass

authMiddleware?​

protected optional authMiddleware?: AuthMiddleware

Defined in: src/routes/BaseAuthBasicRoute.ts:41

Inherited from​

BaseAuthBasicRoute.authMiddleware

defaultScopes​

protected defaultScopes: string[] = []

Defined in: src/routes/BaseAuthBasicRoute.ts:44

Inherited from​

BaseAuthBasicRoute.defaultScopes

jwtConfig?​

protected optional jwtConfig?: any

Defined in: src/routes/BaseAuthBasicRoute.ts:47

Inherited from​

BaseAuthBasicRoute.jwtConfig

rateLimiter?​

protected optional rateLimiter?: RateLimiter

Defined in: src/routes/BaseAuthBasicRoute.ts:50

Inherited from​

BaseAuthBasicRoute.rateLimiter

secretClass​

protected secretClass: any = SecretSQL

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

Overrides​

BaseAuthBasicRoute.secretClass

secretRepo?​

protected optional secretRepo?: RepoUtils<SecretSQL>

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

Inherited from​

BaseAuthBasicRoute.secretRepo

tokenUtils?​

protected optional tokenUtils?: TokenUtils

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

Inherited from​

BaseAuthBasicRoute.tokenUtils

userClass​

protected userClass: any = UserSQL

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

Overrides​

BaseAuthBasicRoute.userClass

userUtils?​

protected optional userUtils?: UserUtils<UserSQL, AliasSQL>

Defined in: src/routes/BaseAuthBasicRoute.ts:57

Inherited from​

BaseAuthBasicRoute.userUtils

Methods​

authenticate()​

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

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

Authenticates the user using HTTP Basic 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​

BaseAuthBasicRoute.authenticate

initialize()​

protected initialize(): Promise<void>

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

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

Returns​

Promise<void>

Inherited from​

BaseAuthBasicRoute.initialize