← Back to plugin index

Default mTAN Token Edit Flow

Description

Simple configuration for an mTAN token editing self-service flow.

The following steps are automatically generated:

  • A Select mTAN Token Step.
  • A mTAN Token Edit Step (step ID "edit-mtan") to edit the mTAN number and optionally also the label.
  • A Selection Step with an optional mTAN Verification Step (if the number has been edited)
  • An Apply Changes Step

If more advanced features are needed, a Custom Protected Self-Service Flow can be configured.

Type name
DefaultMtanTokenEditFlow
Class
com.airlock.iam.selfservice.application.configuration.flow.DefaultMtanTokenEditFlowConfig
May be used by
Properties
Flow ID (flowId)
Description
Unique ID for this flow, which is used for selecting or referencing a flow.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Access Condition (accessCondition)
Description

Precondition that must be fulfilled for a user to access this flow.

Note the difference to the "Authorization Condition":
  • Access Condition: This condition determines whether a user is allowed to access a service at all. If this condition is not fulfilled, there is nothing that can be done (at least not immediately). Typical examples include having a certain authentication token, or a certain static role. This condition is always checked before the Authorization Condition and if it fails, the REST response has status 403 with error code PRECONDITION_NOT_FULFILLED.
  • Authorization Condition: This condition determines whether the user is currently authorized to access a service. It is expected that completing another authentication flow (step-up) would enable the user to then fulfill the condition. The typical authorization condition checks whether the user has obtained a certain tag (or combination of tags). If the condition fails, the REST response has status 403 with error code NOT_AUTHORIZED.
Attributes
Plugin-Link
Optional
Assignable plugins
Authorization Condition (authorizationCondition)
Description
Precondition that must be fulfilled for the user to be authorized to access this flow without further authentication. Note the difference to the "Access Condition":
  • Access Condition: This condition determines whether a user is allowed to access a service at all. If this condition is not fulfilled, there is nothing that can be done (at least not immediately). Typical examples include having a certain authentication token, or a certain static role. This condition is always checked before the Authorization Condition and if it fails, the REST response has status 403 with error code PRECONDITION_NOT_FULFILLED.
  • Authorization Condition: This condition determines whether the user is currently authorized to access a service. It is expected that completing another authentication flow (step-up) would enable the user to then fulfill the condition. The typical authorization condition checks whether the user has obtained a certain tag (or combination of tags). If the condition fails, the REST response has status 403 with error code NOT_AUTHORIZED.
Attributes
Plugin-Link
Optional
Assignable plugins
mTAN Settings (mtanSettings)
Description
Defines the settings for mTAN.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Label Editable (labelEditable)
Description
If enabled, the label can be edited in this flow.
Attributes
Boolean
Optional
Default value
true
Message Provider (messageProvider)
Description
Creates the message for the verification SMS.
Attributes
Plugin-Link
Mandatory
Assignable plugins
YAML Template (with default values)

type: DefaultMtanTokenEditFlow
id: DefaultMtanTokenEditFlow-xxxxxx
displayName: 
comment: 
properties:
  accessCondition:
  authorizationCondition:
  flowId:
  labelEditable: true
  messageProvider:
  mtanSettings: