← Back to plugin index

Red Flag Raising Step

Description
Non-interactive step that raises the configured red flag if the configured flow condition evaluates to true.
Type name
RedFlagRaisingStep
Class
com.airlock.iam.flow.shared.application.configuration.step.RedFlagRaisingStepConfig
May be used by
Properties
Condition (condition)
Description
Defines the condition under which the configured red flag is raised.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Red Flag (redFlag)
Description
Red flag to be raised if the configured condition evaluates to true. This flag must then be handled by a later step.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Skip Condition (skipCondition)
Description

If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.

Attributes
Plugin-Link
Optional
Assignable plugins
Pre Condition (preCondition)
Description
This step is executed only if the configured pre condition is fulfilled. If the condition is not fulfilled, the step and flow execution fail immediately. The step is not initialized and no step method can be called. If no condition is configured, the behavior is that of a fulfilled pre condition.
Attributes
Plugin-Link
Optional
Assignable plugins
Requires Activation (requiresActivation)
Description
If enabled, this step is only executed if it has been dynamically activated from a previous step. If it has not been activated, the step is skipped (equivalent to when the skip condition is fulfilled).
Attributes
Boolean
Optional
Default value
false
Tags On Success (tagsOnSuccess)
Description
This step grants these tags if it completes successfully.
Attributes
Plugin-List
Optional
Assignable plugins
Step ID (stepId)
Description
ID of this step. This is only needed if this step is the target of a goto action or if this step requires activation.
Attributes
Plugin-Link
Optional
Assignable plugins
Custom Response Attributes (customResponseAttributes)
Description

A list of custom attributes that are returned in the REST response in addition to the standard attributes the step already returns. The custom attributes defined here are only returned if the step result does not lead to an error response.

Custom attributes are added to the response when a step is initialized and when actions are executed on the step. They will therefore be available in the response leading to this step, and in any responses from endpoints specific to this step. For non-interactive steps, custom attributes are accumulated and added to the response leading to the next interactive step.

Custom attributes are not returned for 'retrieve' endpoints.

Attributes
Plugin-List
Optional
Assignable plugins
YAML Template (with default values)

type: RedFlagRaisingStep
id: RedFlagRaisingStep-xxxxxx
displayName: 
comment: 
properties:
  condition:
  customFailureResponseAttributes:
  customResponseAttributes:
  preCondition:
  redFlag:
  requiresActivation: false
  skipCondition:
  stepId:
  tagsOnSuccess: