Skip to main content

EmailPasswordParameters

@webda/auth

Class: EmailPasswordParameters

Defined in: packages/auth/src/email/emailpassword.service.ts:31

EmailPasswordProvider parameters

Extends​

  • ServiceParameters

Constructors​

Constructor​

new EmailPasswordParameters(): EmailPasswordParameters

Returns​

EmailPasswordParameters

Inherited from​

ServiceParameters.constructor

Properties​

allowedEmailDomains?​

optional allowedEmailDomains?: string[]

Defined in: packages/auth/src/email/emailpassword.service.ts:60

Only these email domains may use this provider (see ProviderEmailPolicy)

mailer​

mailer: string

Defined in: packages/auth/src/email/emailpassword.service.ts:36

Mailer service name

Default​

"Mailer"

password​

password: object

Defined in: packages/auth/src/email/emailpassword.service.ts:43

Password rules

policy?​

optional policy?: string

verifier?​

optional verifier?: string

redirects​

redirects: object

Defined in: packages/auth/src/email/emailpassword.service.ts:53

Browser redirects for emailed links (no defaults: init() refuses a missing required one). failure and recover are always required, verified and register unless verification is "none". recover receives the recovery link as ?token=... (the page then calls Auth.Password.Recover). confirm (default failure) receives a verification link opened without the matching session, with ?reason=LOGIN_REQUIRED&token=...: log in then call Auth.Email.Verify with the token

confirm?​

optional confirm?: string

failure?​

optional failure?: string

recover?​

optional recover?: string

register?​

optional register?: string

verified?​

optional verified?: string

throttle​

throttle: object

Defined in: packages/auth/src/email/emailpassword.service.ts:45

Throttling

failedBeforeDelay?​

optional failedBeforeDelay?: number

lockout?​

optional lockout?: number

resendDelay?​

optional resendDelay?: number

trustEmailVerification?​

optional trustEmailVerification?: boolean | string[]

Defined in: packages/auth/src/email/emailpassword.service.ts:62

Whether the verification of the email is believed (see ProviderEmailPolicy)

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type

url​

url: string

Defined in: packages/auth/src/email/emailpassword.service.ts:58

Base url for emailed links

Default​

"/auth/email"

verification​

verification: VerificationMode

Defined in: packages/auth/src/email/emailpassword.service.ts:41

Verification mode

Default​

"before"

Methods​

load()​

load(params?): this

Defined in: packages/auth/src/email/emailpassword.service.ts:68

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with