Email Verification Step
User self-registration flow step that verifies the email address of a user by sending an email with an OTP that has to be entered correctly for the flow to continue.
Note that channel verification is the only way to ensure the uniqueness of email addresses while at the same time not revealing already registered email addresses (if Stealth Mode is enabled).
emailItemDefinition) captchaProvider) - the response of the flow selecting request (when this step is the first interactive step in a flow).
- the step response immediately preceding the protected step (when this step is not the first interactive step in a flow).
Caution: The CAPTCHA only protects the verification of the OTP. The OTP is send to the user before the CAPTCHA is solved.
emailService) otpGenerator) emailMessageProvider) maxFailedAttempts) otpValidity) otpCaseSensitive) sendAsHtml) If enabled, the verification email will be sent as an HTML mail. Otherwise it will be sent as plain text.
Security Warning: If e-mails are sent as HTML, make sure to properly escape values originating from untrusted sources (such as user input during self-registration). This can be achieved by enabling the property 'Escape Values in HTML'.
If a more fine-grained control is required, use a 'Transforming Value Map Provider' with an 'HTML String Escaper' to transform all values of the map. (Alternatively, if you want to transform only individual values of a map, use a 'Value Provider Map' with 'Transforming String Value Providers'.)
maskingSettings) If left empty, the email address will not be masked.
interactiveGotoTargets) dynamicStepActivations) skipCondition) If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.
preCondition) requiresActivation) tagsOnSuccess) stepId) onFailureGotos) If the step fails (no retry) and a goto target for the error code is defined here, the flow does not fail and instead a "goto" to the specified target step is executed. Note that even when the "goto" is executed, any error codes that are considered a failed factor attempt will still increment the "failed attempts" counter, and may lead to the user being locked. Therefore, this may still result in a failed flow.
A typical application of this feature is switching to an alternative authentication factor step, if an external service (e.g. Futurae server, SMS gateway) is not available (error code EXTERNAL_SERVICE_UNAVAILABLE with "Strict Counting" disabled, which will not increment the "failed attempts" counter). Other error codes can be found in the IAM REST documentation, in both the general "Error Codes" section and in the documentation of specific endpoints.
customResponseAttributes) A list of custom attributes that are returned in the REST response in addition to the standard attributes the step already returns. The custom attributes defined here are only returned if the step result does not lead to an error response.
Custom attributes are added to the response when a step is initialized and when actions are executed on the step. They will therefore be available in the response leading to this step, and in any responses from endpoints specific to this step. For non-interactive steps, custom attributes are accumulated and added to the response leading to the next interactive step.
Custom attributes are not returned for 'retrieve' endpoints.
customFailureResponseAttributes)
type: EmailRegistrationVerificationStep
id: EmailRegistrationVerificationStep-xxxxxx
displayName:
comment:
properties:
captchaProvider:
customFailureResponseAttributes:
customResponseAttributes:
dynamicStepActivations:
emailItemDefinition:
emailMessageProvider:
emailService:
interactiveGotoTargets:
maskingSettings:
maxFailedAttempts: 1
onFailureGotos:
otpCaseSensitive: true
otpGenerator:
otpValidity: 300
preCondition:
requiresActivation: false
sendAsHtml: false
skipCondition:
stepId:
tagsOnSuccess: