url | String Optional. URL of the LDAP server to connect to. |
principal | String Optional. The principal for the LDAP server. |
credentials | String Optional. Credentials for the LDAP server. |
timeout | String Optional. Connection timeout in milliseconds. The default value is 30000 milliseconds. |
ldapEnv | Record Optional. Key/value parameters to be passed to JNDI to further define the connection environment. See your JNDI provider documentation or the Oracle JNDI documentation for more information about parameters you can pass to JNDI. |
close | String Flag that specifies whether to close the connection after the service finishes. Set to: yes to close the connection. This is the default. If the close parameter is set to "yes", the connectionHandle parameter must also be mapped. no to leave the connection open and available. |
dn | String The distinguished name indicating the root from to begin the search. |
connectionHandle | Object Required if the close parameter is set to "yes", otherwise it is optional. Connection object returned by a previously invoked LDAP service. |
scope | String The scope of the search. Must be "object" (only search the specified directory entry), "onelevel" (only search the immediate children of the specified directory entry), or "subtree" (search the directory entry, its children, and all their children). |
filter | String The filter string that works with RFC 2254. |
countLimit | String Optional. The maximum number of results to return (0, the default, indicates no limit). |
pageSize | String Optional. The number of entries to return in a page. |
timeLimit | String Optional. The number of milliseconds to wait for the search to complete (0, the default, indicates to wait forever). |
returnAttributes | Record Optional. A list of attribute names to return (an empty array indicates that no results should be returned. A null array, the default, indicates that all attributes should be returned). |
returnObjects | String Optional. Specifies whether or not objects associated with the results should be returned. Can be "yes" or "no". The default is "no". |
dereferenceLinks | String Optional. Whether to return the symbolic link to the entry or the entry itself. Can be "yes"/"no". The default is "yes", which returns the entry to which the link points. |
isDocumentList | String Optional. Whether to return results as a list. Set to: Yes to return results as a Document List containing Documents (IData). The results are returned in the resultsList output parameter. No (the default) to return results as a Document containing Documents. The results are returned in the results output parameter. |
ldapCookie | byte[] Optional. Contains the index of the page count for the search. |
connectionHandle | Object Optional. The returned connection object. Returned only if the close parameter is set to No. |
ldapCookie | byte[] Optional. Contains the index of the page count for the search. |
results | Document Conditional. The returned results of the search. Returned only if isDocumentList is set to No. |
resultsList | Document List Conditional. Returned only if isDocumentList is set to Yes. |