User Identification By Data Step (Public Self-Service)
This step identifies users by their context data items (user data).
Note that if no restriction is violated, or if user feedback is disabled for violated restrictions, this step returns a "success" result and "Tags On Success" are also awarded, even if the user could not be identified. User feedback can be disabled in order to prevent user enumeration ("Stealth Mode").
For more details on restrictions consult the help of the corresponding property in the "Public Self-Service Flow" settings.
contextDataItems) The context data items that are used to identify a user. Combined, they must uniquely identify a user.
Each item defines whether it is required for identification or not.
Required items must be provided for identification and must successfully validate (see validators on each item configuration).
Optional items can be omitted, but if they are provided, they must also successfully validate for the step to succeed.
captchaProvider) - the response of the flow selecting request (when this step is the first interactive step in a flow).
- the step response immediately preceding the protected step (when this step is not the first interactive step in a flow).
ignoreCase) This is an improvement in user-friendliness, but carries a higher risk that the user cannot be clearly identified, resulting in a step error.
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) 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: PublicSelfServiceUserByDataIdentifyingStep
id: PublicSelfServiceUserByDataIdentifyingStep-xxxxxx
displayName:
comment:
properties:
captchaProvider:
contextDataItems:
customFailureResponseAttributes:
customResponseAttributes:
dynamicStepActivations:
ignoreCase: false
interactiveGotoTargets:
onFailureGotos:
preCondition:
requiresActivation: false
skipCondition:
stepId:
tagsOnSuccess: