← Back to plugin index

Filtered Flow Event

Description

Filters flow events based on the below defined properties.

If several of these properties are configured, all conditions must be met.

Note that the filter properties are only applicable to events that are emitted inside a flow. A subscriber will not be notified of an event that was emitted by a session-less REST call (i.e. end-points under /protected/my/ or the end-point /protected/secret-questions).

Use Case 1: You want to subscribe to all events (of the specified type) occurring in a protected self-service flow.
Precondition: You have assigned each self-registration flow a flow ID starting with "prot-self-service-". E.g.: prot-self-service-address-change
Required Pattern for Flow ID: prot-self-service-.*

Use Case 2: You want to subscribe to all events (of the specified type) NOT occurring in a self-registration flow.
Precondition: You have assigned each self-registration flow a flow ID starting with "self-registration-". E.g.: self-registration-business-customers
Required Pattern for Flow ID: ((?!self-registration-).)*

Type name
LoginappFilteredFlowEvent
Class
com.airlock.iam.login.application.configuration.event.LoginappFilteredFlowEventConfig
May be used by
Properties
Step ID Pattern (stepIdPattern)
Description
If configured, the subscriber is only notified of events that have a step ID and whose step ID matches the defined pattern. See plugin documentation for examples.
Attributes
RegEx
Optional
Flow ID / Application ID Pattern (flowIdPattern)
Description
If configured, the subscriber is only notified of events whose flow ID (or application ID in case of an authentication flow) matches the defined pattern. See plugin documentation for examples.
Attributes
RegEx
Optional
Required Flow Type (requiredFlowType)
Description
The subscriber is only notified of events from flows of the configured type. If no type is configured, by default events of any flow type are allowed.
Attributes
String
Optional
Allowed values
Authentication and Authorization, Public Self-Service, Protected Self-Service, User Self-Registration
YAML Template (with default values)

type: LoginappFilteredFlowEvent
id: LoginappFilteredFlowEvent-xxxxxx
displayName: 
comment: 
properties:
  event:
  flowIdPattern:
  requiredFlowType:
  stepIdPattern: