← Back to plugin index

User Representation UI
Description
Settings required to start and stop a user representation process.

The representation interface is accessible at /<loginapp-uri>/ui/app/protected/representation/start and /<loginapp-uri>/ui/app/protected/representation/stop after user authentication.

Type name
RepresentationUi
Class
com.airlock.iam.selfservice.application.configuration.ui.representation.RepresentationUiConfig
May be used by
Protected Self-Service UIs
License-Tags
Representation
Properties
Flow To Start Representation (flowToStartRepresentation)
Description
ID of the flow which is used to start a user representation.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Flow ID
Representee Parameter Name (representeeParameterName)
Description
The name of the request parameter that contains the representee's name.
Attributes
String
Optional
Default value
user
Example
user
Example
representee
Target Location Parameter Name (targetLocationParameterName)
Description
The name of the request parameter that contains the target location.
Attributes
String
Optional
Default value
target
Example
target
Example
targetLocation
Flow To Stop Representation (flowToStopRepresentation)
Description
ID of the flow which is used to stop a user representation process.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Flow ID
YAML Template (with default values) 

type: RepresentationUi
id: RepresentationUi-xxxxxx
displayName: 
comment: 
properties:
  flowToStartRepresentation:
  flowToStopRepresentation:
  representeeParameterName: user
  targetLocationParameterName: target