← Back to plugin index

Simple Migration Selection Option
Description

Simplified configuration of a migration subflow.

Essentially equivalent to an "Advanced Migration Selection Option" with a "Next Authentication Method-based Migration Condition" condition and an implicit "Complete Migration Step" as the last step. Only the credential activation step needs to be configured.

Type name
SimpleMigrationSelectionOption
Class
com.airlock.iam.authentication.application.configuration.migration.SimpleMigrationSelectionOptionConfig
May be used by
Migration Selection Step
Properties
Target Auth Method (targetAuthMethod)
Description
Target authentication method of this migration. This is used as follows:
  • As ID in the list of available options (for POST /<loginapp-uri>/rest/public/authentication/migration/options/retrieve and POST /<loginapp-uri>/rest/public/authentication/migration/options/<id>/select)
  • As the "Target Auth Method" in the automatically generated "Next Authentication Method-based Migration Condition" condition
  • As the "Target Auth Method" in the automatically generated "Complete Migration Step"
Attributes
String
Mandatory
Validation RegEx: [A-Za-z0-9_-]+
Suggested values
AIRLOCK_2FA, MTAN, CRONTO, FIDO, DEVICE_TOKEN, MATRIX, OATH_OTP
Hint Period (hintPeriod)
Description

Ask the user to migrate during this period before the migration becomes mandatory. Any immediate period (e.g. 0d) leads to the users always being forced to migrate at the migration date and the users not being asked to migrate before the migration date.

To always ask the user to migrate as soon as a migration date is set for the user, set this property to a very high value. This setting has no effect if the user has a "Next Auth Method" but no migration date set; in this case the user is always asked to migrate and never forced to migrate.

This property is used to configure the hint period in the automatically created "Next Authentication Method-based Migration Condition" condition.

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).

Attributes
String
Optional
Default value
10d
Example
7d
Example
30d
Example
14d 6h 30m
Steps (steps)
Description
Steps of this subflow. A "Complete Migration Step" is always automatically configured and added to the end of this step sequence.
Attributes
Plugin-List
Mandatory
Assignable plugins
Abort Step Acknowledge Message Step Airlock 2FA Activation Letter Order Step Airlock 2FA Activation Step Airlock 2FA Activation Step (with additional Activation) Airlock 2FA Activation Trusted Session Binding Step Airlock 2FA Authentication Step Airlock 2FA Delete Devices Step Airlock 2FA Device Edit Step Airlock 2FA Mobile Only Authentication Step Airlock 2FA Recovery Trusted Session Binding Step Airlock 2FA Usernameless Authentication Step Apply Changes Step Complete Migration Step Cronto Activation Step Cronto Authentication Step Cronto Device Reset Step Cronto Letter Order Step CrontoSign Swiss Push Activation Step Delete All Device Tokens Step Device Token Authentication Step Device Token Registration Step Email Change Verification Step Email Notification Step Email OTP Authentication Step FIDO Authentication Step FIDO Credential Display Name Change Step FIDO Passwordless Authentication Step FIDO Registration Step Failure Step HTTP Basic Authentication Step Kerberos Authentication Step Legacy Email OTP Authentication Step Login From New Device Step Mandatory Password Change Step Matrix Checking Step Migration Selection Step Missing Account Link Step Never Migrate Step No Operation Step OATH OTP Activation Step OATH OTP Authentication Step OAuth 2.0 Consent Step OAuth 2.0 SSO Step OAuth 2.0 Session Reset Step OTP Check via RADIUS Step Password Letter Order Step Password-only Authentication Step Realm Assignment Step Red Flag Raising Step Remember-Me Reset Step Remember-Me Token Generating Step Remember-Me User Identifying Step Representation SSO Ticket Identifying Step Risk Assessment Step Role-based Tag Acquisition Step SAML 2.0 SP User Identifying Step SSI Authentication Step SSI Issuance Step SSI Passwordless Authentication Step SSI Verification Step SSO Ticket Authentication Step Scriptable Step Secret Questions Provisioning Step Selection Step Set Context Data Step Set Password Step Tag Removal Step Terms Of Services Step User Data Edit Step User Identification By Data Step User Identification Step User Identification with FIDO Authentication Step User Lock Step Username Password Authentication Step Username Password with FIDO Authentication Step Vasco OTP Authentication Step Voluntary Password Change Step mTAN Authentication Step mTAN Token Registration Step mTAN Verification Step
YAML Template (with default values) 

type: SimpleMigrationSelectionOption
id: SimpleMigrationSelectionOption-xxxxxx
displayName: 
comment: 
properties:
  hintPeriod: 10d
  steps:
  targetAuthMethod: