← Back to plugin index

Protected Self-Service UI
Description

User interface configuration for a protected self-service flow.

The flow can be accessed at /<loginapp-uri>/ui/app/protected/select/flow/<Flow ID> after user authentication.

Type name
SelfServiceUi
Class
com.airlock.iam.selfservice.application.configuration.ui.SelfServiceUiConfig
May be used by
Protected Self-Service UIs
Properties
Flow ID (flowId)
Description
The identifier of the self-service flow that the user interface configuration refers to.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Flow ID
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
Airlock 2FA Activation Step Self-Service UI Airlock 2FA Approval UI (Protected Self-service) Custom Configuration-based Self-Service UI Custom JavaScript-based Self-Service UI
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: 'protected.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
Maintenance Message UI Settings
Show Confirmation Page (showConfirmationPage)
Description
If enabled, a confirmation page is shown after a completed self-service flow. Otherwise, the user is directly redirected to the configured 'Completion Target' and a corresponding feedback message 'protected.self-service.pages.messages.completed' is shown.
Attributes
Boolean
Optional
Default value
true
Completion Target (completionTarget)
Description
The target to redirect to when the 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.

Note: In order to redirect to a target application, redirect to the corresponding "Authentication Flow". If the flow can be skipped due to the obtained tags, the user is forwarded to the target application.

Attributes
Plugin-Link
Optional
Assignable plugins
Account Link Management UI Redirect Airlock 2FA Device Management UI Redirect Cronto Device Management UI Redirect Device Token Management UI Redirect FIDO Credential Management UI Redirect OAuth 2.0 Consent Management UI Redirect OAuth 2.0 Session Management UI Redirect Public Self-Service Flow Redirect Redirect to URI Remember-Me Device Management UI Redirect Self-Service Flow Redirect Target Application Redirect User Self-Registration Flow Redirect mTAN Token Management UI Redirect
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.

Note: In order to redirect to a target application, redirect to the corresponding "Authentication Flow". If the flow can be skipped due to the obtained tags, the user is forwarded to the target application.

Attributes
Plugin-Link
Optional
Assignable plugins
Account Link Management UI Redirect Airlock 2FA Device Management UI Redirect Cronto Device Management UI Redirect Device Token Management UI Redirect FIDO Credential Management UI Redirect OAuth 2.0 Consent Management UI Redirect OAuth 2.0 Session Management UI Redirect Public Self-Service Flow Redirect Redirect to URI Remember-Me Device Management UI Redirect Same Flow Redirect Target Self-Service Flow Redirect Target Application Redirect User Self-Registration Flow Redirect mTAN Token Management UI Redirect
Flow Failure Target (flowFailureTarget)
Description
Defines the redirect URL in the case of a failed flow. If not configured and the flow fails, the flow is restarted, unless it has failed immediately, in which case an error page is displayed.
Attributes
Plugin-Link
Optional
Assignable plugins
Account Link Management UI Redirect Airlock 2FA Device Management UI Redirect Cronto Device Management UI Redirect Device Token Management UI Redirect FIDO Credential Management UI Redirect OAuth 2.0 Consent Management UI Redirect OAuth 2.0 Session Management UI Redirect Public Self-Service Flow Redirect Redirect to URI Remember-Me Device Management UI Redirect Same Flow Redirect Target Self-Service Flow Redirect Target Application Redirect User Self-Registration Flow Redirect mTAN Token Management UI Redirect
YAML Template (with default values) 

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