Parameter Descriptions

Host

The name of the LDAP host.

Port

The port to use for the LDAP connection.

Username

Name of a user that has full read access on the LDAP server.

Password

Password of the defined user.

Authentication method

The LDAP implementation method to use: simple, kerberos41, kerberos42, digest, ntlm, or negotiate.

simple

LDAP protocol

The LDAP protocol to use; ldapv2 or ldapv3.

ldapv3

Base

Specifies the distinguished name (DN) that identifies the entry point where the search starts.

You can override it at the class level.

Scope of the search

Search scope: base, onelevel, or subtree.

subtree

Encryption mode

The encryption mode to use: none, ssl, or starttls.

none

Timeout (ms)

Timeout for the connection in milliseconds.

If this value is -1, there is no timeout.

Ignore case

Indicates whether LDAP attributes names matching must be case insensitive.

false

Creation timestamp name

Creation timestamp attribute name. When specified, it allows incremental indexing.

You can override it at the class level.

Modification timestamp name

Modification timestamp attribute name. When specified, it allows incremental indexing.

You can override it at the class level.

LDAP filter

An optional LDAP query filter script.

You can define it at the class level.

Ignore SSL cert

Ignores the SSL certificate used to secure the LDAP server.

true

Name

The internal name for the class. This name displays as a facet in search results.

LDAP class name

The LDAP class name. For example, the person class (see LDAP Classes and Attributes).

Index

The Boolean value that determines whether to index the class. The default value is true. See Classes to Index.

Prefetch

The Boolean value that determines whether to prefetch all the entries of this class before the indexation. Prefetch is useful to improve performance for classes that are referred by another class.

Cache

The Boolean value that determines whether to cache the entries of this class if we encounter them, to avoid fetching them multiple times. Cache is useful to improve performance for classes that are referred by another class.

LDAP attribute name

The LDAP attribute name, for example, memberOf.

If null, the DN is used.

Meta name

The meta name to use for this attribute, for example, Group.

Meta name suffix

Suffixes the meta name with # followed by the DN of the current entry. This option has no effect when the Tree concatenation option is selected.

Join class

The class that this attribute refers to (one of the defined class references, for example, group). See Add LDAP References.

Join attribute

Optional. The LDAP attribute of the referred "Class" to perform the join.

If null, the DN is used.

Tree concatenation

Concatenates the meta value to push on the tree branches of the LDAP entries used in the document.

To configure the concatenation parameters (order, separator, etc.), add a Tree Concatenation Config with the same meta name than this attribute.