User Persisting Step
persistencyStrategy) - INSERT: The user is persisted via insert operation. The step will fail, if a user with the same username as the self-registering user already exists.
- UPDATE: The user is persisted via update operation. The step will fail, if no user with the same username as the self-registering user exists.
- AUTO: The system will choose the 'insert' operation if no user with the self-registering user's username exists and the 'update' operation otherwise.
tokenInsertionHandlers) List of Token Insertion Handlers. Each handler can apply (persist) a specific token from a previous step (which typically stores a description of the token in the flow session).
When using several User Persisting Steps please be aware of the following limitations:
- Token Insertion Handlers are not able to update already persisted tokens
- Only one token per token type (e.g. Airlock 2FA, mTAN) can be persisted during the overall flow
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: UserPersistingStep
id: UserPersistingStep-xxxxxx
displayName:
comment:
properties:
customFailureResponseAttributes:
customResponseAttributes:
onFailureGotos:
persistencyStrategy: INSERT
preCondition:
requiresActivation: false
skipCondition:
stepId:
tagsOnSuccess:
tokenInsertionHandlers: