LDAP query
Configuration interface of the action LDAP query
Actions of type LDAP query allows to execute an LDAP query against an LDAP server in order to retrieve data from that server. For this purpose, an LDAP connection must have been previously configured in the system. Furthermore, it is possible to filter the return values so that only the required attributes are returned.
Parameters
LDAP query details
- Use configured LDAP query?
- If this option is selected, a LDAP query preconfigured in the backend can be selected. Additionally, details about the query are displayed.
- Use client LDAP connction?
- If the option is selected, then the settings under Client which already defined for LDAP will be used . This means that no separate LDAP connection needs to be set up.
- LDAP connection
- LDAP connection, which was preconfigured in the administration.
- Base DN
- Specification of the root directory of the Active Directory defined for the search.
- LDAP query
- Text field for the LDAP query.
- Filter for return values
- Attributes can be added via the plus icon, which are to be delivered with the LDAP query.
Action variables
Actions of type LDAP query provide Action variables which can be used in subsequent actions.
Standard action variables
- [%$<action name>.SUCCESS%]
- Return whether action was successfully executed. Returns Boolean (true/false).
- [%$<action name>.RESULT%]
- Return all results provided by the action in structured form.
- [%$<action name>.ERROR_CODE%]
- The error code thrown in case of an error in the action. Empty if no error occurred.
- [%$<action name>.ERROR_MESSAGE%]
- The thrown error message in the action's error case. Empty if no error occurred.
Action specific action variables
- [%$<actionname>.RESULT.rows[i]%]
- Contains the results obtained by the query in the form of a JSON array, which may contain JSON objects. The properties / attributes of a JSON object, is determined by the returned properties of the LDAP object determined in each case.
- The parameter i specifies the index of the line, starting with 0 for the first row. The other attributes can be accessed using dot notation.
- Example RESULT:
{"rows":[{"mail":"beispiel@mail.de","name":"Beispiel"}],"rowsCount":1}
- Access to mail attribute via placeholder: [%$<Aktionsname>.RESULT.rows[0].mail%]
- [%$<action name>.RESULT.rowsCount%]
- Number of rows returned by the query execution. Has the value 0 if the query returned no results or an error occurred.