← Back to plugin index

Failure Step

Description
A flow step to abort and fail the current flow. This step always fails with the configured error code and increments the number of failed attempts for the configured authentication method. If no failed attempts should be counted, use the "Abort Step" instead.
Type name
FailureStep
Class
com.airlock.iam.flow.shared.application.configuration.step.FailureStepConfig
May be used by
Properties
Error Code (errorCode)
Description
The error code which will be included in the response. Allows specifying the reason for aborting the current flow.
Attributes
String
Mandatory
Example
FLOW_ABORTED_INTENTIONALLY
Authentication Method Identifier (authMethod)
Description
Identifies which failed factor attempts counter should be increased.
Attributes
String
Mandatory
Example
PASSWORD
Example
MTAN
Example
CRONTO
Example
FIDO
Example
AIRLOCK_2FA
Skip Condition (skipCondition)
Description

If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.

Attributes
Plugin-Link
Optional
Assignable plugins
Pre Condition (preCondition)
Description
This step is executed only if the configured pre condition is fulfilled. If the condition is not fulfilled, the step and flow execution fail immediately. The step is not initialized and no step method can be called. If no condition is configured, the behavior is that of a fulfilled pre condition.
Attributes
Plugin-Link
Optional
Assignable plugins
Requires Activation (requiresActivation)
Description
If enabled, this step is only executed if it has been dynamically activated from a previous step. If it has not been activated, the step is skipped (equivalent to when the skip condition is fulfilled).
Attributes
Boolean
Optional
Default value
false
Step ID (stepId)
Description
ID of this step. This is only needed if this step is the target of a goto action or if this step requires activation.
Attributes
Plugin-Link
Optional
Assignable plugins
Custom Response Attributes (customResponseAttributes)
Description

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.

Attributes
Plugin-List
Optional
Assignable plugins
YAML Template (with default values)

type: FailureStep
id: FailureStep-xxxxxx
displayName: 
comment: 
properties:
  authMethod:
  customFailureResponseAttributes:
  customResponseAttributes:
  errorCode:
  preCondition:
  requiresActivation: false
  skipCondition:
  stepId: