← Back to plugin index

Custom JavaScript-based Public Self-Service UI

Description

User interface configuration for a custom JavaScript public self-service flow step.

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

Type name
CustomJavaScriptPublicSelfServiceStepUi
Class
com.airlock.iam.publicselfservice.application.configuration.ui.CustomJavaScriptPublicSelfServiceStepUiConfig
May be used by
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
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
YAML Template (with default values)

type: CustomJavaScriptPublicSelfServiceStepUi
id: CustomJavaScriptPublicSelfServiceStepUi-xxxxxx
displayName: 
comment: 
properties:
  pageId:
  requiredStepAction:
  stepId: