Skip to main content

AuthenticationParameters

@webda/auth

Class: AuthenticationParameters

Defined in: packages/auth/src/authentication.service.ts:80

Authentication parameters

Extends​

  • ServiceParameters

Constructors​

Constructor​

new AuthenticationParameters(): AuthenticationParameters

Returns​

AuthenticationParameters

Inherited from​

ServiceParameters.constructor

Properties​

compatibility?​

optional compatibility?: AuthenticationCompatibility

Defined in: packages/auth/src/authentication.service.ts:105

v3 data compatibility

Default​

{ "v3": true }

identModel?​

optional identModel?: string

Defined in: packages/auth/src/authentication.service.ts:90

Ident model

Default​

"Webda/Ident"

linking?​

optional linking?: LinkingPolicy

Defined in: packages/auth/src/authentication.service.ts:95

Linking policy

Default​

"verified"

registration?​

optional registration?: boolean

Defined in: packages/auth/src/authentication.service.ts:100

Allow automatic registration of new users

Default​

true

type​

type: string

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

Type of the service

Inherited from​

ServiceParameters.type

userModel?​

optional userModel?: string

Defined in: packages/auth/src/authentication.service.ts:85

User model

Default​

"Webda/User"

Methods​

load()​

load(params?): this

Defined in: packages/auth/src/authentication.service.ts:111

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