← Back to plugin index

Generic Step Result With Identified User
Description

Event that is published with every step result during flows, only in case the user has been identified at event creation time.

All configured filters must apply ("AND" logic). To achieve "OR" logic, multiple subscribers can be configured.

This plugin is useful for subscribers which require user data (e.g. user ID, contextData) to be present for their event handling. For example an SMS Event Subscriber sending an SMS to the user's phone number.

In case user data is NOT required for the event handling, the "Generic Step Result" plugin can be used.

Type name
GenericStepResultWithUserSubscribedEvent
Class
com.airlock.iam.login.application.configuration.event.GenericStepResultWithUserSubscribedEventConfig
May be used by
Gateway Session Terminator Subscriber (Loginapp) Filtered Flow Event Remote Event Subscriber (Loginapp) Email Event Subscriber (Loginapp) SMS Event Subscriber (Loginapp) Airlock 2FA Push Event Subscriber (Loginapp)
Properties
Step ID Filter (stepIdFilter)
Description
If configured, the subscriber is only notified of events that have a step ID and whose step ID matches the defined pattern.
Attributes
RegEx
Optional
Flow ID Filter (flowIdFilter)
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.
Attributes
RegEx
Optional
Flow Type Filter (flowTypeFilter)
Description
If configured, the subscriber is only notified of events from flows of the configured type.
Attributes
String
Optional
Allowed values
Authentication and Authorization, Public Self-Service, Protected Self-Service, User Self-Registration
Result Type Filter (resultTypeFilter)
Description
If configured, the subscriber is only notified of events if the step result is of the configured type.
Attributes
String
Optional
Allowed values
SUCCESS, STAY, SKIP, FAIL, FAIL_RETRY, SUBFLOW_SELECTED, GOTO, FAIL_GOTO, INTERNAL_ERROR
Next Action Filter (nextActionFilter)
Description
If configured, the subscriber is only notified of events that have a "next step action" code and if this code matches the configured pattern.
Attributes
RegEx
Optional
Error Code Filter (errorCodeFilter)
Description
If configured, the subscriber is only notified of events that have an error code code and if this code matches the configured pattern.
Attributes
RegEx
Optional
YAML Template (with default values) 

type: GenericStepResultWithUserSubscribedEvent
id: GenericStepResultWithUserSubscribedEvent-xxxxxx
displayName: 
comment: 
properties:
  errorCodeFilter:
  flowIdFilter:
  flowTypeFilter:
  nextActionFilter:
  resultTypeFilter:
  stepIdFilter: