# LdapAuthenticationModuleType (Complex Type)

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

Supertype: AbstractAuthenticationModuleType
LDAP authentication module supports authentication via LDAP server.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property string | [0,1] | Unique name of the authentication module.
identifier | property string | [1,1] | Unique module identifier.
description | property string | [0,1] | Free form description of the module (administrator comment).
focusType | property QName | [0,1] | Type of logged object that this authentication module applies to.
documentation | property string | [0,1] | Technical documentation for a particular object or construct.
host | property string | [1,1] | Host of the LDAP server.
userDn | property string | [1,1] | The user distinguished name.
userPassword | property ProtectedStringType | [1,1] | The password (credentials) to use for getting authenticated contexts.
dnPattern | property string | [0,1] | The pattern which will be used to supply a DN for the user.
search | container LdapSearchAuthenticationModuleType | [0,1] | Search configuration which uses an Ldap filter to locate the user

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Unique name of the authentication module. This name is fact a short identifier. It is supposed to give some idea about nature of the module to system administrator. But it is not supposed to be used as a user-friendly label for the module. Module name must be unique.

    Deprecated, use identifier instead

  - #### identifier

    Flags: RAM,runtime

    Multiplicity: [1,1]

    Display order:

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

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Free form description of the module (administrator comment).

  - #### focusType

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Type of logged object that this authentication module applies to. E.g UserType, RoleType, OrgType, ...

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

  - #### host

    Flags: RAM,runtime

    Multiplicity: [1,1]

    Display order:

    Host of the LDAP server.

  - #### userDn

    Flags: RAM,runtime

    Multiplicity: [1,1]

    Display order:

    The user distinguished name.

  - #### userPassword

    Flags: RAM,runtime

    Multiplicity: [1,1]

    Display order:

    The password (credentials) to use for getting authenticated contexts.

  - #### dnPattern

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    The pattern which will be used to supply a DN for the user.

  - #### search

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Search configuration which uses an Ldap filter to locate the user