@sourceloop/authentication-service / Exports / AuthenticationServiceComponent
Class: AuthenticationServiceComponent¶
Implements¶
Component
Table of contents¶
Constructors¶
Properties¶
- application
- authConfig
- bindings
- config
- controllers
- mfaConfig
- models
- otpConfig
- providers
- repositories
Methods¶
- setupAuthenticationComponent
- setupAuthorizationComponent
- setupMultiFactorAuthentication
- setupSequence
Constructors¶
constructor¶
• new AuthenticationServiceComponent(application
, mfaConfig
, otpConfig
, authConfig?
, config?
)
Parameters¶
Name | Type |
---|---|
application |
RestApplication |
mfaConfig |
IMfaConfig |
otpConfig |
IOtpConfig |
authConfig? |
IAuthServiceConfig |
config? |
AuthenticationConfig |
Defined in¶
services/authentication-service/src/component.ts:115
Properties¶
application¶
• Private
Readonly
application: RestApplication
Defined in¶
services/authentication-service/src/component.ts:117
authConfig¶
• Private
Optional
Readonly
authConfig: IAuthServiceConfig
Defined in¶
services/authentication-service/src/component.ts:123
bindings¶
• bindings: Binding
<any
>[] = []
Implementation of¶
Component.bindings
Defined in¶
services/authentication-service/src/component.ts:189
config¶
• Private
Optional
Readonly
config: AuthenticationConfig
Defined in¶
services/authentication-service/src/component.ts:125
controllers¶
• Optional
controllers: ControllerClass
<any
>[]
An array of controller classes
Implementation of¶
Component.controllers
Defined in¶
services/authentication-service/src/component.ts:206
mfaConfig¶
• Private
Readonly
mfaConfig: IMfaConfig
Defined in¶
services/authentication-service/src/component.ts:119
models¶
• Optional
models: Class
<Model
>[]
An optional list of Model classes to bind for dependency injection
via app.model()
API.
Defined in¶
services/authentication-service/src/component.ts:201
otpConfig¶
• Private
Readonly
otpConfig: IOtpConfig
Defined in¶
services/authentication-service/src/component.ts:121
providers¶
• providers: ProviderMap
= {}
Implementation of¶
Component.providers
Defined in¶
services/authentication-service/src/component.ts:187
repositories¶
• Optional
repositories: Class
<Repository
<Model
>>[]
An optional list of Repository classes to bind for dependency injection
via app.repository()
API.
Defined in¶
services/authentication-service/src/component.ts:195
Methods¶
setupAuthenticationComponent¶
▸ setupAuthenticationComponent(secureClient?
): void
Parameters¶
Name | Type | Default value |
---|---|---|
secureClient |
boolean |
false |
Returns¶
void
Defined in¶
services/authentication-service/src/component.ts:217
setupAuthorizationComponent¶
▸ setupAuthorizationComponent(): void
Returns¶
void
Defined in¶
services/authentication-service/src/component.ts:346
setupMultiFactorAuthentication¶
▸ setupMultiFactorAuthentication(): void
Returns¶
void
Defined in¶
services/authentication-service/src/component.ts:354
setupSequence¶
▸ setupSequence(): void
Setup ServiceSequence by default if no other sequnce provided
Returns¶
void