stages

EmailStage Viewset

post/stages/email/

Request body

namestring required
use_global_settingsboolean

When enabled, global Email connection settings will be used and connection settings below will be ignored.

hoststring
portinteger
usernamestring
passwordstring
use_tlsboolean
use_sslboolean
timeoutinteger
from_addressstring email
token_expirystring

Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

subjectstring
templatestring
activate_user_on_successboolean

Activate users upon completion of stage.

recovery_max_attemptsinteger
recovery_cache_timeoutstring

The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

Response

pkstring uuid required
namestring required
componentstring required

Get object type so that we know how to edit the object

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

use_global_settingsboolean

When enabled, global Email connection settings will be used and connection settings below will be ignored.

hoststring
portinteger
usernamestring
use_tlsboolean
use_sslboolean
timeoutinteger
from_addressstring email
token_expirystring

Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

subjectstring
templatestring
activate_user_on_successboolean

Activate users upon completion of stage.

recovery_max_attemptsinteger
recovery_cache_timeoutstring

The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

Changes

No recorded changes to this endpoint across all 1 revision of this API.