Skip to main content

AuthenticationParameters

@webda/core • Readme | API


Class: AuthenticationParameters

Interface to specify the Service parameters

Extends​

Constructors​

new AuthenticationParameters(params)​

new AuthenticationParameters(params): AuthenticationParameters

Parameters​

• params: any

Returns​

AuthenticationParameters

Overrides​

ServiceParameters.constructor

Source​

packages/core/src/services/authentication.ts:185

Properties​

email?​

email?: Object

Enable the email authentication

Type declaration​

delay​

delay: number

Minimal delay between two password recovery or validation email

Default​
3600000 * 4
failedLoginBeforeDelay​

failedLoginBeforeDelay: number

When a delay is added between two attempt to authenticate

Default​
3
mailer?​

mailer?: string

Mailer service name

postValidation​

postValidation: boolean

Allow user to create their account without validating their email first

skipEmailValidation​

skipEmailValidation: boolean

Do not even validate the email at all

Source​

packages/core/src/services/authentication.ts:131


failureRedirect​

failureRedirect: string

Redirect to this page when email validation failed

Source​

packages/core/src/services/authentication.ts:175


identModel?​

identModel?: string

Idents store for authentication identifiers

Default​

"Webda/Ident"

Source​

packages/core/src/services/authentication.ts:117


openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

packages/core/src/services/service.ts:260


password​

password: Object

Type declaration​

regexp?​

regexp?: string

Regexp that password must check

Default​
"{8,}"
verifier?​

verifier?: string

Password verifier Service name

Source​

packages/core/src/services/authentication.ts:157


registerRedirect​

registerRedirect: string

Redirect to this page once email is validate to finish the registration process

Source​

packages/core/src/services/authentication.ts:183


salt​

salt: string

Number of salt iteration for bcrypt.hashSync

Source​

packages/core/src/services/authentication.ts:171


successRedirect​

successRedirect: string

Redirect to this page when email validation succeed

Source​

packages/core/src/services/authentication.ts:179


type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

packages/core/src/services/service.ts:251


url?​

url?: string

Default​

"/auth"

Overrides​

ServiceParameters.url

Source​

packages/core/src/services/authentication.ts:127


userModel?​

userModel?: string

User store for authentication users

Default​

"Webda/User"

Source​

packages/core/src/services/authentication.ts:123