Migration Selection Step
availableOptions) neverMigratePossible) If this property is enabled, it is possible for a user to reject the migration if:
- No migration date is set for the user OR
- A migration date is set and the property "Allow 'Never Migrate' Despite Migration Date" is enabled.
neverMigratePossibleWithToDate) Whether it is possible to "Never Migrate" depends on whether or not a migration date is set and whether the authentication is happening during the "Never Migrate Period" (if set at all).
neverMigratePeriod) Defines the period before the migration date in which the feature "Never Migrate" is active.
Prerequisites for this property to take effect:- A migration date must be set for the user.
- "Never Migrate Possible" must be enabled.
- "Never Migrate Possible Despite Migration Date" must be enabled.
- At least one available option must define a "Hint Period" greater or equal to this property.
If this property is not set, the feature "Never Migrate" is possible (if enabled) during and after the entire "Hint Period".
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).
customNeverMigrateCondition) customNeverMigrateSteps) customSkipMigrationSteps) 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) 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: MigrationSelectionStep
id: MigrationSelectionStep-xxxxxx
displayName:
comment:
properties:
availableOptions:
customFailureResponseAttributes:
customNeverMigrateCondition:
customNeverMigrateSteps:
customResponseAttributes:
customSkipMigrationSteps:
dynamicStepActivations:
interactiveGotoTargets:
neverMigratePeriod:
neverMigratePossible: false
neverMigratePossibleWithToDate: false
onFailureGotos:
preCondition:
requiresActivation: false
skipCondition:
stepId: