Specification of authentication module in the sequence.
The authentication modules are evaluated in sequence (or in parallel if possible). At least one authentication module must succeed for authentication to be successful. If there are required or requisite modules in the sequence then all of them must succeed for the sequence to be successful.
| Name | Type | Multiplicity | Description |
|---|---|---|---|
| name |
property string |
[0,1] | Reference to the authentication module name. |
| identifier |
property string |
[1,1] | Unique module identifier. |
| display |
container DisplayType |
[0,1] | |
| description |
property string |
[0,1] | Free form description (administrator comment). |
| documentation |
property string |
[0,1] | Technical documentation for a particular object or construct. |
| order |
property int |
[0,1] | Ordering number for the module. |
| necessity |
property AuthenticationSequenceModuleNecessityType |
[0,1] | Necessity, i. |
| acceptEmpty |
property boolean |
[0,1] | Some modules might be automatically skipped if the concrete type of credentials is not defined. |
| action |
container GuiActionType |
[0,1] | Action which can be produced from this module's UI form. |
Flags: RAM,runtime
Multiplicity: [0,1]
Deprecated, use identifier instead.
Flags: RAM,runtime
Multiplicity: [1,1]
Flags: RAM,runtime
Multiplicity: [0,1]
Flags: RAM,runtime
Multiplicity: [0,1]
Flags: RAM,runtime
Multiplicity: [0,1]
Technical documentation for a particular object or construct.
The purpose of this element is to document system configuration and behavior.
The documentation will not be presented to end users. In fact, it will probably
not be presented at all in midPoint user interface. This documentation element
is supposed to be a part of the technical documentation of midPoint deployment.
The tools than generate deployment configuration will look for these elements
and combine them to compiled documentation document.
AsciiDoc formatting is assumed for this element. Any leading or trailing
whitespace is skipped. Indentation equivalent to he indentation of the first
non-blank line of text is also skipped.
Flags: RAM,runtime
Multiplicity: [0,1]
Flags: RAM,runtime,AVals:4
Multiplicity: [0,1]
Flags: RAM,runtime
Multiplicity: [0,1]
Some modules might be automatically skipped if the concrete type of credentials is not defined. E.g.
if there is no "hint" defined for the user, we can skip evaluation of the hint module. The same can
apply for example for security questions.
In case the module can be skipped, accept empty must be set to 'true'. After module is set, it is
marked as CALLED_OFF in the sequence.
Flags: RAM,runtime
Multiplicity: [0,1]
Action which can be produced from this module's UI form. E.g. redirecting to the documentation page