# AuthenticationSequenceModuleType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

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.

Item Summary
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.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Reference to the authentication module name. Value of this element must match name of existing authentication module.

    Deprecated, use identifier instead.

  - #### identifier

    Flags: RAM,runtime

    Multiplicity: [1,1]

    Display order:

    Unique module identifier. Can be used to reference the module.

  - #### display

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Free form description (administrator comment).

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    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.

  - #### order

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Ordering number for the module. The modules are sorted according to those numbers. Modules that have the same value of "order" can be evaluated in parallel in case that actual use of authentication mechanism allows that.

  - #### necessity

    Flags: RAM,runtime,AVals:4

    Multiplicity: [0,1]

    Display order:

    Necessity, i.e. the level of requirement, whether the module is mandatory or optional.

  - #### acceptEmpty

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    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.

  - #### action

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Action which can be produced from this module's UI form. E.g. redirecting to the documentation page