config properties password

Version

v1.2.1

password Type

object (password)

password Properties

Property	Type	Required	Nullable	Defined by
acquire_on_registration	string	Optional	cannot be null	Config
acquire_on_login	string	Optional	cannot be null	Config
enabled	boolean	Optional	cannot be null	Config
min_length	integer	Optional	cannot be null	Config
min_password_length	integer	Optional	cannot be null	Config
optional	boolean	Optional	cannot be null	Config
recovery	boolean	Optional	cannot be null	Config

acquire_on_registration

acquire_on_registration configures how users are prompted creating a password on registration.

acquire_on_registration

• is optional

• cannot be null

acquire_on_registration Type

string

acquire_on_registration Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"always"	Indicates that users are always prompted to create a password on registration.
"conditional"	Indicates that users are prompted to create a password on registration as long as the user does not have a passkey. If passkeys are also conditionally acquired on registration, then users are given a choice as to what type of credential to register.
"never"	Indicates that users are never prompted to create a password on registration.

acquire_on_registration Default Value

The default value is:

"always"

acquire_on_login

acquire_on_login configures how users are prompted creating a password on login.

acquire_on_login

• is optional

• cannot be null

acquire_on_login Type

string

acquire_on_login Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"always"	Indicates that users are always prompted to create a password on login provided that they do not already have a password.
"conditional"	Indicates that users are prompted to create a password on login provided that they do not already have a password and do not have a passkey. If passkeys are also conditionally acquired on login then users are given a choice as to what type of credential to register.
"never"	Indicates that users are never prompted to create a password on login.

acquire_on_login Default Value

The default value is:

"never"

enabled

enabled determines whether passwords are enabled or disabled.

enabled

• is optional

• cannot be null

enabled Type

boolean

enabled Default Value

The default value is:

true

min_length

min_length determines the minimum password length.

min_length

• is optional

• cannot be null

min_length Type

integer

min_length Default Value

The default value is:

8

min_password_length

Deprecated. Use min_length instead.

min_password_length

• is optional

• cannot be null

min_password_length Type

integer

min_password_length Default Value

The default value is:

8

optional

optional determines whether users must set a password when prompted. The password cannot be deleted if passwords are required (optional: false).

It also takes part in determining the order of password and passkey acquisition on login and registration (see also acquire_on_login and acquire_on_registration): if one credential type is required (optional: false) then that one takes precedence, i.e. is acquired first.

optional

• is optional

• cannot be null

optional Type

boolean

recovery

recovery determines whether users can start a recovery process, e.g. in case of a forgotten password.

recovery

• is optional

• cannot be null

recovery Type

boolean

recovery Default Value

The default value is:

true