← Back to plugin index

Set Authentication Method Migration Step

Description

Non-interactive step to set the user's authentication method migration and optionally a migration deadline.

Any authentication method set in previous steps is overwritten by this step.

Type name
NonInteractiveAuthMethodMigrationStep
Class
com.airlock.iam.userselfreg.application.configuration.step.NonInteractiveAuthMethodMigrationStepConfig
May be used by
License-Tags
SelfRegistration
Properties
Authentication Method (authenticationMethod)
Description
The authentication method to migrate to.
Attributes
String
Mandatory
Suggested values
AIRLOCK_2FA, CRONTO, FIDO, MTAN, EMAILOTP, OATH_OTP
Migration Deadline (migrationDeadline)
Description

The migration date is set to this period of time after the step is executed. If no period is defined, no migration date is set.

The duration must be specified in the format "(d)ays (h)ours (m)inutes (s)econds", e.g. "2d 4h 10m 5s" (any part can be omitted).

For the usage of the migration date, please refer to the documentation of the "Migration Selection Step".

Attributes
String
Optional
Example
7d
Example
30d
Example
14d 6h 30m
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
Tags On Success (tagsOnSuccess)
Description
This step grants these tags if it completes successfully.
Attributes
Plugin-List
Optional
Assignable plugins
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
On Failure Gotos (onFailureGotos)
Description

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.

Attributes
Plugin-Map
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: NonInteractiveAuthMethodMigrationStep
id: NonInteractiveAuthMethodMigrationStep-xxxxxx
displayName: 
comment: 
properties:
  authenticationMethod:
  customFailureResponseAttributes:
  customResponseAttributes:
  migrationDeadline:
  onFailureGotos:
  preCondition:
  requiresActivation: false
  skipCondition:
  stepId:
  tagsOnSuccess: