User Guide

216 Chapter 2: ColdFusion Tags
Attributes
Attribute Req/Opt Default Description
server Required Host name or IP address of LDAP server.
port Optional 389 Port
username Required if
secure =
"CFSSL_BASIC"
(anonymous) User ID
password Required if
secure =
"CFSSL_BASIC"
Password that corresponds to user name.
If
secure = "CFSSL_BASIC", V2 encrypts the
password before transmission.
action Optional query •
query: returns LDAP entry information only.
Requires
name, start, and attributes attributes.
•
add: adds LDAP entries to LDAP server.
Requires
attributes attribute.
•
modify: modifies LDAP entries, except
distinguished name
dn attribute, on LDAP server.
Requires
dn. See modifyType attribute.
•
modifyDN: modifies distinguished name attribute
for LDAP entries on LDAP server. Requires
dn.
•
delete: deletes LDAP entries on an LDAP
server. Requires
dn.
name Required if
action =
"Query"
Name of LDAP query. The tag validates the value.
timeout Optional 60 Maximum length of time, in seconds, to wait for
LDAP processing.
maxRows Optional Maximum number of entries for LDAP queries.
start Required if
action =
"Query"
Distinguished name of entry to be used to start a
search.
scope Optional oneLevel Scope of search, from entry specified in
start
attribute for
action = "Query".
• oneLevel: entries one level below entry.
• base: only the entry.
• subtree: entry and all levels below it.
attributes Required if
action =
"Query"
,
"Add",
"ModifyDN", or
"Modify"
For queries: comma-delimited list of attributes to
return. For queries, to get all attributes, specify
"*".
If
action = "add" or "modify", you can specify a
list of update columns. Separate attributes with a
semicolon.
If
action = "ModifyDN", ColdFusion passes
attributes to the LDAP server without syntax
checking.
filter Optional "objectclass = *" Search criteria for
action = "query".
List attributes in the form:
"(attribute operator value)" Example: "(sn =
Smith)"