<CFLDAP SERVER="server_name" PORT="port_number" USERNAME="name" PASSWORD="password" ACTION="action" NAME="name" TIMEOUT="seconds" MAXROWS="number" START="distinguished_name" SCOPE="scope" ATTRIBUTES="attribute, attribute" FILTER="filter" SORT="sort_order" DN="distinguished_name" STARTROW="row_number">
CFLDAP provides an interface to LDAP (Lightweight Directory Access Protocol) directory servers like the Netscape Directory Server. For complete examples of CFLDAP usage, refer to Advanced ColdFusion Development.
Required. Host name ("biff.upperlip.com") or IP address ("192.1.2.225") of the LDAP server.
Optional. Port defaults to the standard LDAP port, 389.
Optional. If no user name is specified, the LDAP connection will be anonymous.
Optional. Password corresponds to user name.
Optional. Specifies the LDAP action. There are five possible values:
Required for ACTION="Query". The name you assign to the LDAP query.
Optional. Specifies the maximum amount of time in seconds to wait for LDAP processing. Defaults to 60 seconds.
Optional. Specifies the maximum number of entries for LDAP queries.
Required for ACTION="Query". Specifies the distinguished name of the entry to be used to start the search.
Optional. Specifies the scope of the search from the entry specified in the Start attribute for ACTION="Query". There are three possible values:
Required for ACTION="Query", Add, ModifyDN, and Modify. For queries, specifies the comma-separated list of attributes to be returned for queries. Can also 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.
Optional. Specifies the search criteria for ACTION="Query". Attributes are referenced in the form: "(attribute operator value)". Example: "(sn=Smith)". Default is "objectclass=*".
Optional. Specifies the attribute to sort query results by. Enter Asc for an ascending sort and Desc for a descending sort.
Required for ACTION="Add", Modify, ModifyDN, and Delete. Specifies the distinguished name for update actions. Example: "cn=Barbara Jensen, o=Ace Industry, c=US".