Public self-services UIs

The plugin Public Self-Service UI defines the UI for the public self-service flow. To configure a UI for a public self-service flow defined in the Loginapp REST API, follow the steps below.

Prerequisite

The public self-service flow (e.g. password reset), is configured in Loginapp >> Public Self-Service Flows. The page ID of the flow must be known.

Regarding the password reset flow, the Loginapp REST UI only supports the "flow-based" API and not the non-flow-based legacy API.

The UI of the public self-service is automatically inferred from the service configuration. 

The following optional properties help to further customize the UI. Please also refer to the documentation in the Config Editor - they may contain additional information, especially for properties not listed here. 

Table: Selected properties of the Public Self-Service UI plugin

Property

Description

Customized Step UIs

Gives full control over the UI for each flow step. It allows configuring UI elements such as input fields, buttons, checkboxes, radio buttons, labels, etc.

Example: Define your own UI for the step setting the password.

Completion Target

Defines what page to show (or redirect to) after successfully passing the flow.

Example: Show login UI for default authentication flow.

Cancellation Target

Defines what page to show (or redirect to) if the flow is canceled by the end-user.

Example: Go back to the start of the flow.

URLs for public self-service UIs

A public self-service UI is reached using the following URLs:

URL

Description

<loginapp-uri>/ui/app/self-service/flow/<flow-id>

Example: <loginapp-uri>/ui/app/self-service/flow/password-reset

Starts the flow with the id flow-id.

Example: <loginapp-uri>/ui/app/self-service/flow/password-reset

Starts the password reset flow with ID password-reset.

Note that you can place a link to a public self-service on the login page.

  • Go to:
    Loginapp >> UI Settings >> Authentication UIs >> affected Flow UI.
  • If not yet present add a Customized Step UI of type Password Authentication UI.
  • Use property Public Self-Service Link to specify to what flow a link should be displayed on the login page.

Example with password reset:

132684069.png