LDAP Query Component
:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:
Description
Makes a request to the directory service server using the LDAP protocol.
Index |
|
Short name |
|
Script types |
|
Start module |
|
Mode |
Asynchronous |
Icon |
|
Branching type |
Branching, closing |
Properties
| Specification | Description |
|---|---|
Name: Protocol Code: Visibility condition: no Default: |
Protocol for connecting to the server. Possible options:
|
Name: Server addresses
Code: Default: — |
List of directory service server addresses. As a string, where addresses are separated by any character: comma, semicolon, space, tab, end of line. Domain names, IP addresses, as well as URIs from which the domain name will be obtained can be specified. An attempt will be made to establish a connection, searching through all addresses until completion or success. |
Name: Port Code: Visibility condition: no Default: — |
Port for connecting to servers. Default 389 for LDAP, 636 for LDAPS. |
Name: Certificate Code: Visibility condition: no Default: — |
For SSL/TLS connection points, points to the PEM certificate file located in the ':SYNC_DOMAIN' or ':SYNC_COMMON' directory. The certificate file can be loaded, for example, into the REST-endpoint '/rest/v1/fs/targets/files/certificates/cert.pem' and addressed via ':SYNC_DOMAIN_DATA/files/certificates/cert.pem'. Used when switching LDAP to TLS, as well as LDAPS. If not specified, the client connection will check the server certificate for trust using the trusted chains installed in the system. To refuse verification of the server certificate for trust, specify 'verify_none' in the field. |
Authorization parameter: domain. For example, If a domain is specified, then when connecting, the user URI is formed as 'login@domain'. However, not all servers support this format. If you need to specify the account URI in full format ( |
|
Authorization parameter: login. Can be in full |
|
Name: Password Code: Visibility condition: no Default: — |
Authorization parameter: password. |
Name: Timeout, s
Code: Default: — |
Timeout for waiting for the operation to complete, in seconds. |
Name: Action Code: Visibility condition: no Default: Authorize |
Options for operations in the directory service. Possible options:
|
Name: Visibility condition: yes Default: — |
Name of the domain in which the operation is performed. Applies to all actions except Authorize. For example, |
Name: Reach Code: Visibility condition: yes Default: Entire branch |
Select scope for search operation. Applies to the Find action. Possible options:
|
Name: Attributes Code: Visibility condition: yes Default: — |
Attributes to search. Applies to the Find action. For example, |
Name: Search string Code: Visibility condition: yes Default: — |
Search string in the directory service. Applies to the Find action. Two formats are supported. Format 1 - LDAP filter (rfc4515) Example:
Format 2 - expression Example: Available functions: Available operations: |
Name: Attributes Code: Visibility condition: yes Default: — |
Attributes of the new or modified element. Applies to the Create and Edit actions. |
Name: New password
Code: Default: — |
New password. Applies to the Change Password action. |
Name: Old password Code: Visibility condition: yes Default: — |
Old password used to check correctness when changing. Applies to the Change Password action. |
Name: New DN Code: Visibility condition: yes Default: — |
New name for the element. Applies to the Change DN action. |
Name: Parent DN Code: Visibility condition: yes Default: — |
Parent element. Applies to the Change DN action. |
Name: Result into variable Code: Visibility condition: no Default: — |
Variable for storing the result of the operation. |
Name: Error code into variable Code: Visibility condition: no Default: — |
Variable for storing the error code. |
Name: Transition, success Code: Visibility condition: no Default: — |
The component to which control is transferred if the operation completes successfully. |
Name: Transition, error
Code: Default: — |
Component to which control is transferred in case of an error. |
See also
-
Role svc