← Back to plugin index

Start User Representation Step

Description
Self-service step that starts a user representation process on the representer's side.
Type name
StartUserRepresentationStep
Class
com.airlock.iam.selfservice.application.configuration.step.StartUserRepresentationStepConfig
May be used by
License-Tags
Representation
Properties
Representation Authorization (representationAuthorization)
Description
Defines the condition that checks if a representer is authorized to represent a specific user. If the desired condition is independent of the representee, the flow's "Access Condition" could be configured instead.
Attributes
Plugin-Link
Optional
Assignable plugins
Role Providers (roleProviders)
Description
Plugins to determine the roles to be incorporated into the SSO ticket.

The roles will be added to the SSO ticket under the key 'roles'.

Attributes
Plugin-List
Optional
Assignable plugins
Ticket Encoder (ticketEncoder)
Description
The ticket encoder plugin used to sign and encrypt the SSO ticket.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Allowed Target Locations (allowedTargetLocationPatterns)
Description

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.

Attributes
RegEx-List
Optional
Default value
[/(?!/).*]
Representee Access URI (representeeAccessUri)
Description
The URI of the login application in which the representee session will be created.

Note the different URIs for SPA or Non-SPA IAM on the representee side.

Attributes
String
Mandatory
Validation RegEx: https?:\/\/.*
Example
https://represent.bank.ch/auth/ui/app/auth/application/access
Example
https://represent.bank.ch/auth/check-login
Representee Logout URI (representeeLogoutUri)
Description
The logout URI to be called on the representee side.

Note the different URIs for SPA or Non-SPA IAM on the representee side.

Attributes
String
Mandatory
Validation RegEx: https?:\/\/.*
Example
https://represent.bank.ch/auth/ui/app/auth/logout
Example
https://represent.bank.ch/auth/logout
Language Parameter Name (languageParameterName)
Description
The name of the language parameter to be propagated into the receiving IAM.

No language is propagated, if this parameter is not configured.

Attributes
String
Optional
Example
lang
Example
language
Ticket Parameter Name (ticketParameterName)
Description
The SSO ticket request parameter name. The same value must be configured on the receiver side.
Attributes
String
Optional
Default value
representation
Example
representation
Example
sso
Example
ticket
Interactive Goto Targets (interactiveGotoTargets)
Description
Manually selectable Goto targets. These are steps to which the user can chose to jump when this is the current flow step.
Attributes
Plugin-List
Optional
Assignable plugins
Dynamic Step Activations (dynamicStepActivations)
Description
Steps that can be dynamically activated while in this step.
Attributes
Plugin-List
Optional
Assignable plugins
Skip Condition (skipCondition)
Description

If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.

Attributes
Plugin-Link
Optional
Assignable plugins
Pre Condition (preCondition)
Description
This step is executed only if the configured pre condition is fulfilled. If the condition is not fulfilled, the step and flow execution fail immediately. The step is not initialized and no step method can be called. If no condition is configured, the behavior is that of a fulfilled pre condition.
Attributes
Plugin-Link
Optional
Assignable plugins
Requires Activation (requiresActivation)
Description
If enabled, this step is only executed if it has been dynamically activated from a previous step. If it has not been activated, the step is skipped (equivalent to when the skip condition is fulfilled).
Attributes
Boolean
Optional
Default value
false
Tags On Success (tagsOnSuccess)
Description
This step grants these tags if it completes successfully.
Attributes
Plugin-List
Optional
Assignable plugins
Step ID (stepId)
Description
ID of this step. This is only needed if this step is the target of a goto action or if this step requires activation.
Attributes
Plugin-Link
Optional
Assignable plugins
On Failure Gotos (onFailureGotos)
Description

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.

Attributes
Plugin-Map
Optional
Assignable plugins
Custom Response Attributes (customResponseAttributes)
Description

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.

Attributes
Plugin-List
Optional
Assignable plugins
YAML Template (with default values)

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