Authenticates an user against an LDAP server.

If the user is authenticated its ID is set in current context/session and thereby the current context/session is authenticated.
The user ID is set using the Login property. and the LDAP password is set by the password property
Note: Although its Output property is set to false by default, this step generates an LDAPAuthenticated XML Element in output, that should always contain a user attribute with the user ID value if the step succeeds.
The generated XML element has a userDn XML Attribute which contain the distinguished name (dn) associated if one was found in the directory.

Property Type Category Description
Comment String standard Describes the object comment to include in the documentation report.
This property generally contains an explanation about the object.
Is active boolean standard Defines whether the step is active.
LDAP admin login SmartType standard Defines the login that has to be used for directory search.
This property is a “smart type” property, that allows to define the user ID to set in authentication.
A “smart type” property can be of one of the following types:

• a text: the value is therefore a default text value,
• a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution,
• a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.

Note: If you use the source type for this property, the XPath application on target XML should give a text result. Otherwise, the first node’s text content is taken.
If addressing a Microsoft ActiveDirectory LDAP, Login may be in these 3 forms :• DOMAIN\username
• username@domain.xx
• cn=username,cn=users,dc=domain,dc=xx
LDAP admin password SmartType standard Defines the password that has to be used for directory search.
This property is a “smart type” property, that allows to define the user ID to set in authentication.
A “smart type” property can be of one of the following types:

• a text: the value is therefore a default text value,
• a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution,
• a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.

LDAP base path SmartType standard Defines the directory base path that has to be used for directory search.
This property is a “smart type” property, that allows to define the user ID to set in authentication.
A “smart type” property can be of one of the following types:

• a text: the value is therefore a default text value,
• a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution,
• a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.

LDAP binding policy LdapBindingPolicy standard Defines the policy to apply to bind to the server.
This property specifies whether to search for the user before binding.
It has the following options:

• bind: try to bind the server using given user Login
• search and bind: search if user exist in directory then bind using found distinguished name or given user Login

LDAP servers SmartType standard Defines the comma separated server URLs to use.
This property is a “smart type” property, that allows to define the user ID to set in authentication.
A “smart type” property can be of one of the following types:

• a text: the value is therefore a default text value,
• a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution,
• a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.

LDAP server can be defined as a DNS name or IP address , default port is 389.Note: If you use the source type for this property, the XPath application on target XML should give a text result. Otherwise, the first node’s text content is taken.
LDAP user login SmartType standard Defines the login that has to be used for directory bind and set as authenticated login.
This property is a “smart type” property, that allows to define the user ID to set in authentication.
A “smart type” property can be of one of the following types:

• a text: the value is therefore a default text value,
• a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution,
• a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.

Note: If you use the source type for this property, the XPath application on target XML should give a text result. Otherwise, the first node’s text content is taken.
If addressing a Microsoft ActiveDirectory LDAP, Login may be in these 4 forms :• username
• DOMAIN\username
• username@domain.xx
• cn=username,cn=users,dc=domain,dc=xx
LDAP user password SmartType standard Defines the password that has to be used for directory bind and set as authenticated password.
This property is a “smart type” property, that allows to define the user ID to set in authentication.
A “smart type” property can be of one of the following types:

• a text: the value is therefore a default text value,
• a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution,
• a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.

Note: If you use the source type for this property, the XPath application on target XML should give a text result. Otherwise, the first node’s text content is taken.
Output boolean expert Defines whether the XML generated by this step should be appended to the resulting XML.
Set this property to true to add the step’s resulting XML to the sequence’s output XML (default value for steps generating XML). Set this property to false to prevent the steps’s XML result to appear in the sequence’s output XML.
Setting this property to false does not prevent the step’s generated XML from being used as a source by other steps.
Search Attributes SmartType expert Defines an optional list of attributes to search.
Only works if LDAP binding policy is search and bind.
“This property is a “smart type” property, that allows to define the user ID to set in authentication.
A “smart type” property can be of one of the following types:

• a text: the value is therefore a default text value, use as a list of one item,
• a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution, can be a single string value or a JS array of string values
• a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.