Restart Action

The Restart action restarts the ongoing action pipeline. It supports two different operation modes.

The Restart action supports the following operation modes:

ModeDescription
AlwaysAlways restart action pipeline.
Attribute ConditionCheck for a boolean attribute and restart action pipeline if that attribute value matches the expected one.

After the action pipeline is restarted the associated authenticator can be invoked again before the action pipeline is rerun. This behavior is configured using the re-run-authenticator configuration option.

Configuration#

The following configuration options are available:

ConfigurationMandatoryDescription
alwaysNoAlways restart action pipeline.
attribute-conditionNoRestart action pipeline depending on the presence of an attribute.
attribute-condition/nameYesThe name of the attribute.
attribute-condition/sourceYesThe source of the attribute (subject-attributes, context-attributes, action-attributes)
attribute-condition/expected-valueNoThe expected value of the attribute to restart action pipeline. Defaults to: true

Note that either always or attribute-condition must be specified. Also note that setting the re-run-authenticator to true in an SSO action pipeline without setting clear-sso-session-for-authenticator also to true has no effect and the authenticator will not be invoked (since during the SSO an authenticator is not run).

When using this action in the SSO pipeline and setting both re-run-authenticator and clear-sso-session-for-authenticator to true, then the restart will be to the login pipeline (including the authenticator) and not to the SSO pipeline, since the SSO session will no longer exist.

Back-channel support#

This action can be used in back-channel authentication.

Was this helpful?