User Guide

116 CFML Language Reference
• Modify — Modifies LDAP entries on an LDAP server with the exception of the
distinguished name ("DN") attribute. Requires DN, ATTRIBUTES. See the
MODIFYTYPE attribute for additional controls.
• ModifyDN — Modifies the distinguished name attribute for LDAP entries on an
LDAP server. Requires DN, ATTRIBUTES.
• Delete — Deletes LDAP entries on an LDAP server. Requires DN.
NAME
Required for ACTION="Query". The name you assign to the LDAP query.
TIMEOUT
Optional. Specifies the maximum amount of time in seconds to wait for LDAP
processing. Defaults to 60 seconds.
MAXROWS
Optional. Specifies the maximum number of entries for LDAP queries.
START
Required for ACTION="Query". Specifies the distinguished name of the entry to
be used to start the search.
SCOPE
Optional. Specifies the scope of the search from the entry specified in the Start
attribute for ACTION="Query". There are three possible values:
• OneLevel — (Default) Searches all entries one level beneath the entry specified
in the START attribute.
• Base — Searches only the entry specified in the START attribute.
• Subtree — Searches the entry specified in the START attribute as well all entries
at all levels beneath it.
ATTRIBUTES
Required for ACTION="Query", Add, ModifyDN, and Modify. For queries, specifies
the comma-separated list of attributes to be returned for queries. For queries, you
can also specify the wild card "*" to get all the attributes associated with the entry.
In addition, it can be used to specify the list of update columns for ACTION="Add"
or "Modify". When used with ACTION="Add" and Action="Modify", separate
multiple attributes with a semicolon. When used with ACTION="ModifyDN",
ColdFusion passes attributes to the LDAP server without performing any syntax
checking.
FILTER
Optional. Specifies the search criteria for ACTION="Query". Attributes are
referenced in the form: "(attribute operator value)". Example: "(sn=Smith)".
Default is "objectclass=*".
If you also specify the FILTERFILE attribute, the filter is considered to be a search
string not a filter.