← Back to plugin index

Public Self-Service Flow

Description
Configuration for a public self-service flow.
Type name
PublicSelfServiceFlow
Class
com.airlock.iam.publicselfservice.application.configuration.flow.PublicSelfServiceFlowConfig
May be used by
Properties
Flow ID (flowId)
Description
Unique ID for this flow, which is used for selecting or referencing a flow.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Restrictions (restrictions)
Description
Restrictions to define which users are allowed to perform this public self-service. These restrictions are checked for each step of the flow. Typically, it is also possible to configure whether feedback to the user is enabled or not (user enumeration protection).
Attributes
Plugin-Link
Mandatory
Assignable plugins
Username Transformers (usernameTransformers)
Description
Username transformers may transform the provided username into the single unique user ID required for the flow.
The transformation of a username takes place in the first step before the user is loaded. Note that username transformers have no effect on the propagated username value. Transformers can be chained, i.e. a first transformer could normalize the original name, where the next transformer looks up the normalized name in a database for potential transformation matches.
In contrary to the above description of chaining, a transformer can also signal that it already found the final user ID and the chain must stop after it.
For further details please refer to the documentation of the username transformer plugins.
Attributes
Plugin-List
Optional
Assignable plugins
Initialize Next Auth Flow (initializeNextAuthFlow)
Description

If enabled, the next authentication flow after completing this public self-service flow will be initialized with the user identity and tags from the public self-service flow. By combining this feature with authentication flows where steps can be skipped based on tags from public self-service, a non-interactive authentication after completed public self-service can be achieved.

Information is propagated only if a user has been identified in the public flow.

Attributes
Boolean
Optional
Default value
false
YAML Template (with default values)

type: PublicSelfServiceFlow
id: PublicSelfServiceFlow-xxxxxx
displayName: 
comment: 
properties:
  flowId:
  initializeNextAuthFlow: false
  processors:
  restrictions:
  steps:
  usernameTransformers: