Start User Representation Step
representationAuthorization) roleProviders) The roles will be added to the SSO ticket under the key 'roles'.
ticketEncoder) allowedTargetLocationPatterns) A list of regular expressions defining the allowed target locations.
A target location is accepted if at least one of the configured regular expressions matches.
The default pattern is "/(?!/).*", which allows all context-relative URLs, i.e. URLs starting with a forward slash.
Since the forward location is provided by the request, the pattern should be as restrictive as possible.
representeeAccessUri) Note the different URIs for SPA or Non-SPA IAM on the representee side.
representeeLogoutUri) Note the different URIs for SPA or Non-SPA IAM on the representee side.
languageParameterName) No language is propagated, if this parameter is not configured.
ticketParameterName) representerIdValueProvider) 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: StartUserRepresentationStep
id: StartUserRepresentationStep-xxxxxx
displayName:
comment:
properties:
allowedTargetLocationPatterns: [/(?!/).*]
customFailureResponseAttributes:
customResponseAttributes:
dynamicStepActivations:
interactiveGotoTargets:
languageParameterName:
onFailureGotos:
preCondition:
representationAuthorization:
representeeAccessUri:
representeeLogoutUri:
representerIdValueProvider:
requiresActivation: false
roleProviders:
skipCondition:
stepId:
tagsOnSuccess:
ticketEncoder:
ticketParameterName: representation