config properties email

Version

v1.2.1

email Type

object (email)

email 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
limit	integer	Optional	cannot be null	Config
max_length	integer	Optional	cannot be null	Config
optional	boolean	Optional	cannot be null	Config
passcode_ttl	integer	Optional	cannot be null	Config
require_verification	boolean	Optional	cannot be null	Config
use_as_login_identifier	boolean	Optional	cannot be null	Config
use_for_authentication	boolean	Optional	cannot be null	Config

acquire_on_login

acquire_on_login determines whether users, provided that they do not already have registered an email, are prompted to provide an email on login.

acquire_on_login

• is optional

• cannot be null

acquire_on_login Type

boolean

acquire_on_registration

acquire_on_registration determines whether users are prompted to provide an email 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 emails are enabled.

enabled

• is optional

• cannot be null

enabled Type

boolean

enabled Default Value

The default value is:

true

limit

'limit' determines the maximum number of emails a user can register.

limit

• is optional

• cannot be null

limit Type

integer

limit Default Value

The default value is:

5

max_length

max_length specifies the maximum allowed length of an email address.

max_length

• is optional

• cannot be null

max_length Type

integer

max_length Default Value

The default value is:

100

optional

optional determines whether users must provide an email when prompted. There must always be at least one email address associated with an account. The primary email address cannot be deleted if emails are required (optional: false`).

optional

• is optional

• cannot be null

optional Type

boolean

passcode_ttl

passcode_ttl specifies, in seconds, how long a passcode is valid for.

passcode_ttl

• is optional

• cannot be null

passcode_ttl Type

integer

passcode_ttl Default Value

The default value is:

300

require_verification

require_verification determines whether newly created emails must be verified by providing a passcode sent to respective address.

require_verification

• is optional

• cannot be null

require_verification Type

boolean

require_verification Default Value

The default value is:

true

use_as_login_identifier

use_as_login_identifier determines whether emails can be used as an identifier on login.

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

use_for_authentication

user_for_authentication determines whether users can log in by providing an email address and subsequently providing a passcode sent to the given email address.

use_for_authentication

• is optional

• cannot be null

use_for_authentication Type

boolean

use_for_authentication Default Value

The default value is:

true