Skip to main content

Abstract Class: BaseAuthPasskeyRouteMongo

Defined in: auth/src/routes/mongo/BaseAuthPasskeyRouteMongo.ts:8

Extends​

Constructors​

Constructor​

new BaseAuthPasskeyRouteMongo(): BaseAuthPasskeyRouteMongo

Returns​

BaseAuthPasskeyRouteMongo

Inherited from​

BaseAuthPasskeyRoute.constructor

Properties​

aliasClass​

protected aliasClass: any = AliasMongo

Defined in: auth/src/routes/mongo/BaseAuthPasskeyRouteMongo.ts:9

Overrides​

BaseAuthPasskeyRoute.aliasClass

aliasRepo?​

protected optional aliasRepo?: RepoUtils<AliasMongo>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:40

Inherited from​

BaseAuthPasskeyRoute.aliasRepo

authMiddleware?​

protected optional authMiddleware?: AuthMiddleware

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:43

Inherited from​

BaseAuthPasskeyRoute.authMiddleware

defaultScopes​

protected defaultScopes: string[] = []

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:46

Inherited from​

BaseAuthPasskeyRoute.defaultScopes

jwtConfig?​

protected optional jwtConfig?: any

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:49

Inherited from​

BaseAuthPasskeyRoute.jwtConfig

messagingUtils?​

protected optional messagingUtils?: MessagingUtils

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:52

Inherited from​

BaseAuthPasskeyRoute.messagingUtils

passkeyConfig​

protected passkeyConfig: PasskeyConfig

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:60

Inherited from​

BaseAuthPasskeyRoute.passkeyConfig

rateLimiter?​

protected optional rateLimiter?: RateLimiter

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:55

Inherited from​

BaseAuthPasskeyRoute.rateLimiter

secretClass​

protected secretClass: any = SecretMongo

Defined in: auth/src/routes/mongo/BaseAuthPasskeyRouteMongo.ts:10

Overrides​

BaseAuthPasskeyRoute.secretClass

secretRepo?​

protected optional secretRepo?: RepoUtils<SecretMongo>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:57

Inherited from​

BaseAuthPasskeyRoute.secretRepo

tokenUtils?​

protected optional tokenUtils?: TokenUtils

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:67

Inherited from​

BaseAuthPasskeyRoute.tokenUtils

userClass​

protected userClass: any = UserMongo

Defined in: auth/src/routes/mongo/BaseAuthPasskeyRouteMongo.ts:11

Overrides​

BaseAuthPasskeyRoute.userClass

userRepo?​

protected optional userRepo?: RepoUtils<UserMongo>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:69

Inherited from​

BaseAuthPasskeyRoute.userRepo

userUtils?​

protected optional userUtils?: UserUtils<UserMongo, AliasMongo>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:71

Inherited from​

BaseAuthPasskeyRoute.userUtils

Methods​

authenticate()​

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

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:138

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

BaseAuthPasskeyRoute.authenticate

getCredentialById()​

protected getCredentialById(credentialId): Promise<StoredPasskeyCredential | undefined>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:146

Parameters​

credentialId​

string

Returns​

Promise<StoredPasskeyCredential | undefined>

Inherited from​

BaseAuthPasskeyRoute.getCredentialById

getCredentials()​

protected getCredentials(id): Promise<StoredPasskeyCredential[]>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:163

Parameters​

id​

string

Returns​

Promise<StoredPasskeyCredential[]>

Inherited from​

BaseAuthPasskeyRoute.getCredentials

getUser()​

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

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:197

Retrieve the user associated with a given uid or alias.

Parameters​

id​

string

The unqique id of the user or alias to lookup.

Returns​

Promise<JWTUser | undefined>

Inherited from​

BaseAuthPasskeyRoute.getUser

initialize()​

protected initialize(): Promise<void>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:77

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

Returns​

Promise<void>

Inherited from​

BaseAuthPasskeyRoute.initialize

updateCredentialCounter()​

protected updateCredentialCounter(credentialId, newCounter): Promise<void>

Defined in: auth/src/routes/BaseAuthPasskeyRoute.ts:204

Parameters​

credentialId​

string

newCounter​

number

Returns​

Promise<void>

Inherited from​

BaseAuthPasskeyRoute.updateCredentialCounter