Legacy Email OTP Authentication Step
Configuration for an authentication flow step to check an OTP sent via email.
Note: Emails are neither confidential nor authentic (i.e. the user cannot be sure that the email is really from Airlock IAM and Airlock IAM cannot be sure that the email is delivered to the correct user). Therefore, this step must not be used for high-security applications.emailService) messageTemplate) The string $TOKEN$ in the message template is mandatory and is replaced by the generated OTP.
If the message text is in HTML code, enable the property "Message Template Is HTML".
In order to access our services, please provide the following security code: $TOKEN$
Your Airlock IAM Server
messageTemplateIsHtml) emailSubject) ignoreCase) credentialPersister) maskingSettings) If left empty, the email address will not be masked.
otpGenerator) otpValiditySeconds) The value 0 (zero) disables this feature, i.e. OTPs never expire (this is the default).
maxRetries) authenticationMethodId) Example: a system tracks two passwords per user. Password 1 is used in flow A, password 2 in flow B. These two steps must have distinct 'Authentication Method Ids', e.g. PASSWORD1 and PASSWORD2.
If only one identifier (e.g. "PASSWORD") is used, this may allow brute force attacks on the password as follows. Assuming an attacker knows the user's password 1, they get an unlimited number of attempts on flow B, as the 'PASSWORD' counter can repeatedly be reset to 0 by performing a successful login on flow A.To prevent such attacks, use two different counters by setting the authentication methods, for example, to PASSWORD1 and PASSWORD2, respectively.
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: LegacyEmailOtpAuthenticationStep
id: LegacyEmailOtpAuthenticationStep-xxxxxx
displayName:
comment:
properties:
authenticationMethodId: EMAIL
credentialPersister:
customFailureResponseAttributes:
customResponseAttributes:
dynamicStepActivations:
emailService:
emailSubject:
ignoreCase: false
interactiveGotoTargets:
maskingSettings:
maxRetries: 0
messageTemplate: $TOKEN$
messageTemplateIsHtml: true
onFailureGotos:
otpGenerator:
otpValiditySeconds: 0
preCondition:
requiresActivation: false
skipCondition:
stepId:
tagsOnSuccess: