Email (Section)#
Path: /profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/email
An email authenticator. Sends a challenge over email
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| max-challenges-sent | uint16 | optional | 3 | The maximum number of Email-challenges that is allowed to be sent during one session. When this value is set to 0, there is no maximum attempts enforced. |
| max-allowed-attempts | uint16 | optional | 3 | The maximum number times a user can try to validate the nonce sent with a hyperlink. When this value is set to 0, there is no maximum attempts enforced. |
| allow-inactive-accounts | boolean | optional | false | If set to true, the authenticator will not check if the account is active before sending the hyperlink. |
| activate-inactive-accounts | boolean | optional | false | If set to true, the authenticator will change the account status to active once the hyperlink sent was consumed by the user. |
Subsections#
| Name | Type | Description |
|---|---|---|
| email-provider | Section | Use a custom email provider. Enabling this will override the email provider configured in the default zone. |
| hyperlink-or-otp | OneOf | None |
| throttler-provider | OneOf | None |
| account-manager-or-intermediate-attribute | OneOf | None |