Send Email Link Step
Flow step that sends an email with a link to the current user. This link allows the user to perform further steps in a specified public self-service flow. Because the link contains an unguessable token, no further identity verification is necessary in the target flow.
Typical use-cases:
- Password reset with identity verification using email link: Flow 1: public self-service flow with user identification step, followed by email link step. Flow 2: flow continuation step followed by password reset set.
- Email address verification after self-registration: Flow 1: user self-registration flow that locks the user, email link step at the end of the flow. Flow 2: Flow 2: flow continuation step followed by unlock step.
targetFlowId) recipientAddress) emailService) subjectResourceKey) bodyResourceKey) repository) continuationUrl) ${token}- the random continuation token${flowId}- the ID of the target flow to continue${language}- the current language used in the flow
valueProviders) List of value map providers that are used to replace the variables in the localized template. The values providers are called in the configured order and their values are added to a map. Later providers can overwrite values from earlier providers. If no value providers are configured, the localized template should not contain any variables, since all of them would be replaced by empty strings. The link to continue the process is always added as ${TOKEN} and doesn't have to be configured here.
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'.)
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'.)
tokenValidity) The duration must be specified in the format "2d 4h 10m 5s" (any part can be omitted).
storeForwardUrl) escapeHtmlValues) HTML-escape all provided values if property Send As HTML is enabled.
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'.)
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: SendEmailLinkStep
id: SendEmailLinkStep-xxxxxx
displayName:
comment:
properties:
bodyResourceKey:
continuationUrl:
customFailureResponseAttributes:
customResponseAttributes:
emailService:
escapeHtmlValues: true
onFailureGotos:
preCondition:
recipientAddress:
repository:
requiresActivation: false
sendAsHtml: false
skipCondition:
stepId:
storeForwardUrl: true
subjectResourceKey:
tagsOnSuccess:
targetFlowId:
tokenValidity: 24h
valueProviders: