auth.ExternalAuthService

Class: ExternalAuthService<UserType>

auth.ExternalAuthService

Type parameters

Name	Type
UserType	extends ApplicationUserContract

Hierarchy

• AuthService<UserType>

  ↳ ExternalAuthService

Table of contents

Constructors

• constructor

Properties

• authProviderService
• jwtService
• logger
• updateLock
• userService

Methods

• addToBlacklist
• createApplicationUser
• createAuthUser
• decodeAuthorizationHeaderToken
• getApplicationUser
• isBlackListed
• isValid
• updateApplicationUser
• userDataChanged

Constructors

constructor

• new ExternalAuthService<UserType>(authProviderService, userService, jwtService): ExternalAuthService<UserType>

Type parameters

Name	Type
UserType	extends ApplicationUserContract

Parameters

Name	Type
authProviderService	AuthProviderServiceContract
userService	UserServiceContract<UserType>
jwtService	JwtService

Returns

ExternalAuthService<UserType>

Overrides

AuthService&lt;UserType&gt;.constructor

Defined in

packages/auth/src/services/external-auth.service.ts:21

Properties

authProviderService

• Private Readonly authProviderService: AuthProviderServiceContract

Defined in

packages/auth/src/services/external-auth.service.ts:23

---

jwtService

• Protected Readonly jwtService: JwtService

Inherited from

AuthService.jwtService

Defined in

packages/auth/src/services/external-auth.service.ts:25

---

logger

• Private Readonly logger: Logger

Defined in

packages/auth/src/services/external-auth.service.ts:19

---

updateLock

• Private updateLock: string[] = []

Defined in

packages/auth/src/services/external-auth.service.ts:18

---

userService

• Private Readonly userService: UserServiceContract<UserType>

Defined in

packages/auth/src/services/external-auth.service.ts:24

Methods

addToBlacklist

▸ addToBlacklist(jwtPayload): void

Parameters

Name	Type
jwtPayload	JwtPayload

Returns

void

Inherited from

AuthService.addToBlacklist

Defined in

packages/auth/src/services/auth.service.ts:38

---

createApplicationUser

▸ createApplicationUser(externalId): Promise<null | UserID>

Parameters

Name	Type
externalId	UserID

Returns

Promise<null | UserID>

Defined in

packages/auth/src/services/external-auth.service.ts:68

---

createAuthUser

▸ createAuthUser(users): Promise<number>

Parameters

Name	Type
users	CreateAuthProviderUser[]

Returns

Promise<number>

Defined in

packages/auth/src/services/external-auth.service.ts:64

---

decodeAuthorizationHeaderToken

▸ decodeAuthorizationHeaderToken(headerToken): JwtPayload

Parameters

Name	Type
headerToken	string

Returns

JwtPayload

Inherited from

AuthService.decodeAuthorizationHeaderToken

Defined in

packages/auth/src/services/auth.service.ts:21

---

getApplicationUser

▸ getApplicationUser(token, createIfNotExists?, updateIfChanged?): Promise<null | UserType>

Parameters

Name	Type	Default value
token	JwtPayload	undefined
createIfNotExists	boolean	true
updateIfChanged	boolean	true

Returns

Promise<null | UserType>

Overrides

AuthService.getApplicationUser

Defined in

packages/auth/src/services/external-auth.service.ts:30

---

isBlackListed

▸ isBlackListed(jwtPayload): boolean

Parameters

Name	Type
jwtPayload	JwtPayload

Returns

boolean

Inherited from

AuthService.isBlackListed

Defined in

packages/auth/src/services/auth.service.ts:34

---

isValid

▸ isValid(jwtPayload): boolean

Parameters

Name	Type
jwtPayload	JwtPayload

Returns

boolean

Inherited from

AuthService.isValid

Defined in

packages/auth/src/services/auth.service.ts:25

---

updateApplicationUser

▸ updateApplicationUser(externalId, user): Promise<null | UserID>

Parameters

Name	Type
externalId	UserID
user	UserType

Returns

Promise<null | UserID>

Defined in

packages/auth/src/services/external-auth.service.ts:89

---

userDataChanged

▸ userDataChanged(user, token): boolean

Parameters

Name	Type
user	ApplicationUserContract
token	JwtPayload

Returns

boolean

Inherited from

AuthService.userDataChanged

Defined in

packages/auth/src/services/auth.service.ts:12