← Back to plugin index

Maintenance Message UI Settings
Description
UI-specific maintenance message settings. These settings are not relevant when the system is not available. If the system is not available a separate page is displayed.
Type name
MaintenanceMessageUiSettings
Class
com.airlock.iam.flow.api.application.configuration.MaintenanceMessageUiSettings
May be used by
Authentication & Authorization UI Protected Self-Service UI Public Self-Service UI User Self-Registration UI Non-Flow UI Settings
License-Tags
MaintenanceMessages
Properties
Location Filters (locationFilters)
Description
The location filter for which maintenance messages should be displayed. Only maintenance message items whose location property is matched by at least one of the filters will be displayed if the corresponding locations are also configured at Loginapp > Maintenance Message Settings. If the location functionality is not used, this property should be empty. More information about filtering can be found in the Loginapp REST API documentation.
Attributes
Plugin-List
Optional
Assignable plugins
Location Filter
Display on first page only (firstPageOnly)
Description
If this flag is enabled the maintenance message is only displayed on the first page of the flow. The property has no effect on pages that do not belong to a specific flow.
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values) 

type: MaintenanceMessageUiSettings
id: MaintenanceMessageUiSettings-xxxxxx
displayName: 
comment: 
properties:
  firstPageOnly: true
  locationFilters: