Abstract Class: BaseAuthOIDCRoute<U, A, P>

Defined in: src/routes/BaseAuthOIDCRoute.ts:22

Extended by

• BaseAuthOIDCRouteMongo
• BaseAuthOIDCRouteSQL

Type Parameters

U

U extends User

A

A extends Alias

P

P extends Profile

Constructors

Constructor

new BaseAuthOIDCRoute<U, A, P>(): BaseAuthOIDCRoute<U, A, P>

Returns

BaseAuthOIDCRoute<U, A, P>

Properties

aliasClass

abstract protected aliasClass: any

Defined in: src/routes/BaseAuthOIDCRoute.ts:23

---

aliasRepo?

protected optional aliasRepo?: RepoUtils<A>

Defined in: src/routes/BaseAuthOIDCRoute.ts:27

---

authMiddleware?

protected optional authMiddleware?: AuthMiddleware

Defined in: src/routes/BaseAuthOIDCRoute.ts:30

---

jwtConfig?

protected optional jwtConfig?: any

Defined in: src/routes/BaseAuthOIDCRoute.ts:33

---

messagingUtils?

protected optional messagingUtils?: MessagingUtils

Defined in: src/routes/BaseAuthOIDCRoute.ts:39

---

objectFactory?

protected optional objectFactory?: ObjectFactory

Defined in: src/routes/BaseAuthOIDCRoute.ts:36

---

profileClass

abstract protected profileClass: any

Defined in: src/routes/BaseAuthOIDCRoute.ts:24

---

profileRepo?

protected optional profileRepo?: RepoUtils<P>

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

---

providerConfig

abstract protected providerConfig: OIDCProvider

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

---

userClass

abstract protected userClass: any

Defined in: src/routes/BaseAuthOIDCRoute.ts:25

---

userRepo?

protected optional userRepo?: RepoUtils<U>

Defined in: src/routes/BaseAuthOIDCRoute.ts:45

---

userUtils?

protected optional userUtils?: UserUtils<U, A>

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

Methods

login()

login(user): Promise<AuthResult | undefined>

Defined in: src/routes/BaseAuthOIDCRoute.ts:227

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

Parameters

user

JWTUser

Returns

Promise<AuthResult | undefined>