config properties username

Version

v1.3.1

username Type

object (username)

username Properties

Property	Type	Required	Nullable	Defined by
acquire_on_login	boolean	Optional	cannot be null	Config
acquire_on_registration	boolean	Optional	cannot be null	Config
enabled	boolean	Optional	cannot be null	Config
max_length	integer	Optional	cannot be null	Config
min_length	integer	Optional	cannot be null	Config
optional	boolean	Optional	cannot be null	Config
use_as_login_identifier	boolean	Optional	cannot be null	Config

acquire_on_login

acquire_on_login determines whether users, provided that they do not already have set a username, are prompted to provide a username on login.

acquire_on_login

• is optional

• cannot be null

acquire_on_login Type

boolean

acquire_on_login Default Value

The default value is:

true

acquire_on_registration

acquire_on_registration determines whether users are prompted to provide a username on registration.

acquire_on_registration

• is optional

• cannot be null

acquire_on_registration Type

boolean

acquire_on_registration Default Value

The default value is:

true

enabled

enabled determines whether users can set a unique username.

Usernames can contain letters (a-z,A-Z), numbers (0-9), and underscores.

enabled

• is optional

• cannot be null

enabled Type

boolean

max_length

max_length specifies the maximum allowed length of a username.

max_length

• is optional

• cannot be null

max_length Type

integer

max_length Default Value

The default value is:

32

min_length

min_length specifies the minimum length of a username.

min_length

• is optional

• cannot be null

min_length Type

integer

min_length Default Value

The default value is:

3

optional

optional determines whether users must provide a username when prompted. The username can only be changed but not deleted if usernames are required (optional: false).

optional

• is optional

• cannot be null

optional Type

boolean

optional Default Value

The default value is:

true

use_as_login_identifier

use_as_login_identifier determines whether usernames, if enabled, can be used for logging in.

use_as_login_identifier

• is optional

• cannot be null

use_as_login_identifier Type

boolean

use_as_login_identifier Default Value

The default value is:

true