← Back to plugin index

Authentication & Authorization UI
Description
User interface configuration for authentication and authorization.
Type name
AuthenticationUi
Class
com.airlock.iam.authentication.application.configuration.ui.AuthenticationUiConfig
May be used by
Authentication & Authorization UIs
Properties
Target Application ID (targetApplicationId)
Description
The identifier of the target application that the user interface configuration refers to.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Application 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 Authentication UI Airlock 2FA Activation Authentication UI (with additional Activation) Airlock 2FA Authentication UI Custom Configuration-based Authentication UI Custom JavaScript-based Authentication UI Link Configuration Authentication UI
Language Extractor (languageExtractor)
Description

The Language Extractor is a Location Interpreter which allows the UI to extract the language from the forward location. It is added to the value map from the location interpretation endpoint (/<loginapp-uri>/rest/public/authentication/location/interpret/) with the key IAM_UI_LANGUAGE.

The IAM UI uses this endpoint, when application access with a forward location is requested. For this, an "Application Selector" must be configured on the "Target Application" configuration for the respective authentication flow. Otherwise, this setting has no effect for the default IAM UI.

Attributes
Plugin-Link
Optional
Assignable plugins
Advanced Location Interpreter Simple Location Interpreter
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: 'authentication.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
Self-Unlock Flow (selfUnlockFlow)
Description
The self-unlock flow to use when a user is locked on this authentication flow. If configured, a message is displayed with a link to start this self-unlock flow. The link is displayed using the resource key: authentication.pages.messages.self-unlock
Attributes
Plugin-Link
Optional
Assignable plugins
Public Self-Service Flow Link
Target URI Resolver (targetURIResolver)
Description
Resolves the URI to be propagated to after successful authentication.
  • The resolved URL must either be absolute (i.e. using https://) or start with a slash.
  • It may be necessary to configure 'Identity Propagation' to make the authentication work.
  • Uses the custom 'X-Forward-URL' header to inform the SPA about the target. Do not set the same header again in the identity propagation of the respective authentication flow.
  • Note: this setting is irrelevant for SAML 2.0 target applications (a target application where the "SAML 2.0 Identity Propagator" is configured). For such an application, simply configure a resolver with "/" as default value.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Target URI Resolver
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
Public Self-Service Flow Redirect Redirect to URI Same Flow Redirect Target Target Application Redirect User Self-Registration Flow 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
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
YAML Template (with default values) 

type: AuthenticationUi
id: AuthenticationUi-xxxxxx
displayName: 
comment: 
properties:
  cancellationTarget:
  customizedStepUis:
  flowFailureTarget:
  languageExtractor:
  maintenanceMessageUiSettings:
  selfUnlockFlow:
  showCancelButtonOnFirstPage: false
  showGotoButtons: true
  targetApplicationId:
  targetURIResolver: