← Back to plugin index

Public Self-Service UI

Description
User interface for a public self-service flow.

Note that the corresponding public self-service flow must also be configured in order for this user interface to be available.

Type name
PublicSelfServiceUi
Class
com.airlock.iam.publicselfservice.application.configuration.ui.PublicSelfServiceUiConfig
May be used by
Properties
Flow ID (flowId)
Description
The identifier of the public self-service flow that the user interface configuration refers to.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Customized Step UIs (customizedStepUis)
Description
The user interface configuration for the steps. Note: if using standard IAM steps, no user interface has to be configured manually.
Attributes
Plugin-List
Optional
Assignable plugins
Show Goto Buttons (showGotoButtons)
Description

Show Goto buttons for all configured Goto targets on all pages using default UIs of this flow. Clicking a Goto button will redirect to the corresponding Goto target. The Goto targets are configured in the flows themselves, not the UIs.

For customized step UIs, Goto buttons have to be configured explicitly using the "Goto Button UI Element" plugin.

Notice: Goto buttons do not come with pre-defined labels. It is required to add i18n keys and values for each button manually. The key may looks as follows: 'public-self-service.pages.actions.goto.<currentStepId>.<targetStepId>'.

Attributes
Boolean
Optional
Default value
true
Maintenance Message UI Settings (maintenanceMessageUiSettings)
Description
Settings to define if and how maintenance messages are displayed for this flow. If this property is not set no maintenance messages are displayed for this flow.
Attributes
Plugin-Link
Optional
Assignable plugins
Completion Target (completionTarget)
Description
The target to redirect to when the public self-service flow is successfully completed. If "Show Confirmation Page" is enabled, the page is displayed first and the redirect happens after clicking the "continue" button. If the confirmation page is disabled, this property is mandatory.
Attributes
Plugin-Link
Optional
Assignable plugins
Cancellation Target (cancellationTarget)
Description
If configured, shows a cancel button on all pages, except the first, using default UIs of this flow. Clicking the cancel button will abort the flow and redirect to the configured target.

For customized step UIs, cancel buttons have to be configured explicitly using the "Cancel Button UI Element" plugin.

Attributes
Plugin-Link
Optional
Assignable plugins
Show Cancel Button On First Page (showCancelButtonOnFirstPage)
Description
If enabled, displays the cancel button also on the first interactive page of the flow. This can be useful if the "Cancellation Target" redirects to another flow or external page.

Note that even if this flag is disabled, a cancel button on the first page is always shown when the first page is reached again during the flow, e.g. by a Goto.

Attributes
Boolean
Optional
Default value
false
Show Confirmation Page (showConfirmationPage)
Description
If enabled, a confirmation page is shown after a completed public self-service. Otherwise, the user is directly redirected to the configured 'Completion Target' and a corresponding feedback message 'public-self-service.pages.messages.completed' is shown.
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values)

type: PublicSelfServiceUi
id: PublicSelfServiceUi-xxxxxx
displayName: 
comment: 
properties:
  cancellationTarget:
  completionTarget:
  customizedStepUis:
  flowFailureTarget:
  flowId:
  maintenanceMessageUiSettings:
  showCancelButtonOnFirstPage: false
  showConfirmationPage: true
  showGotoButtons: true