← Back to plugin index

Custom Configuration-based User Self-Registration UI
Description

User interface configuration for a configurable user self-registration flow step.

The step is accessible by the following URI: /<loginapp-uri>/ui/app/registration/flow/<FLOW_ID>/ext/<ID>

Type name
ConfigurableUserSelfRegStepUi
Class
com.airlock.iam.userselfreg.application.configuration.ui.ConfigurableUserSelfRegStepUiConfig
May be used by
User Self-Registration UI
License-Tags
SelfRegistration
Properties
Page ID (pageId)
Description
A unique identifier of the page. This ID is used to derive the page titles with the following keys:
  • custom.page.<ID>.title.caption: to define the caption of the page
  • custom.page.<ID>.title.page: to define HTML page title. If not set, the translation from the caption is used.
Attributes
String
Mandatory
Validation RegEx: [a-z]+(-[a-z]+)*
Step ID (stepId)
Description
The ID of the step to which this UI is referring.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Step ID
Required Step Action (requiredStepAction)
Description
The step action that requires this UI. This must correspond to a "nextStep" that is returned in responses from flow REST calls, and that can be handled by the "Flow Step" referenced by the "Step ID" configured above. Leave empty to match all step actions (preferred method for steps with only one possible step action).
Attributes
String
Optional
Suggested values
CRONTO_DEVICE_CHOICE_REQUIRED, CRONTO_OTP_REQUIRED, MTAN_TOKEN_CHOICE_REQUIRED, MTAN_OTP_REQUIRED, CRONTO_ACTIVATION_START_REQUIRED, CRONTO_ACTIVATION_COMPLETE_REQUIRED
UI Elements (uiElements)
Description
Defines the user interface elements of the step.
Attributes
Plugin-List
Mandatory
Assignable plugins
Button Group UI Element Button UI Element CAPTCHA UI Element Cancel Button UI Element Checkbox UI Element Date UI Element Drop-Down UI Element Form UI Element Goto Button UI Element Hidden UI Element Input UI Element Radio Buttons UI Element Text UI Element
Initial REST Invocation (initialRestInvocation)
Description
A REST API call to execute when loading the page. The data retrieved in this call can be used to display information in UI components, e.g. by configuring the "Initial Value Query" property on supported UI elements.
Attributes
Plugin-Link
Optional
Assignable plugins
Initial REST API Invocation
YAML Template (with default values) 

type: ConfigurableUserSelfRegStepUi
id: ConfigurableUserSelfRegStepUi-xxxxxx
displayName: 
comment: 
properties:
  initialRestInvocation:
  pageId:
  requiredStepAction:
  stepId:
  uiElements: