Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

Ldap Object

The Ldap object exposes methods for invoking LDAP queries from scripts.

Ldap Methods

Ldap.Search()

Purpose

The Ldap.Search() method is used to invoke an LDAP query defined in a [Search/name] section of the ldapauth.aut file.

Syntax

Ldap.Search(SearchSection)

Parameters

Table 142: Ldap.Search() Parameters

Parameter

Description

SearchSection

Specifies the name of a [Search/name] section of the ldapauth.aut file.

Returns

Table 143: Ldap.Search() Return Parameters

Parameter

Description

Ldap.FOUND

The search found a matching LDAP entry.

Ldap.NOTFOUND

The search did not find a matching LDAP entry.

Ldap.FAILED

The search encountered an unexpected failure.

Ldap.NOSUCHSEARCH

The specified section was not found in ldapauth.aut.

Ldap.PASSWORDFAILED

The search found the username, but the password is incorrect.

Example

Given this query definition:

[Search/vpn]Base = ou=vpn dc=jcn dc=comScope = 2Filter = uid=<Vpn-User-Name>Attributes = VpnAttrListTimeout = 20%DN = dn

Use this JavaScript command to invoke the query:

Ldap.Search("vpn");

Modified: 2017-03-07