Restart Action

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

Mode Description
Always Always restart action pipeline.
Attribute Condition Check 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:

Configuration Mandatory Description
always no Always restart action pipeline.
attribute-condition no Restart action pipeline depending on the presence of an attribute.
attribute-condition/name yes The name of the attribute.
attribute-condition/source yes The source of the attribute (subject-attributes, context-attributes, action-attributes)
attribute-condition/expected-value no The expected value of the attribute to restart action pipeline. Defaults to: true
re-run-authenticator no The flag indicating whether authenticator should be rerun again after restart. Defaults to: false
clear-sso-session-for-authenticator no Clears the SSO for the used authenticator and all other authenticators sharing the same ACR. Important: This flag is only considered if re-run-authenticator is set. Defaults to: false

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).

Important

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.