3-1-Tags:CFLdap

last edited by usericon

lmajano on 23-Aug-2009

cfldap

cfldap

Description

Provides an interface to LDAP Lightweight Directory Access Protocol directory servers like the Netscape Directory Server.

Implemented

Usage Syntax

<cfldap  
	[returnAsBinary="String"]
	server="String"
	[port="number"]
	[username="String"]
	[password="String"]
	[action="String"]
	[name="String"]
	[timeout="number"]
	[maxRows="number"]
	[start="String"]
	[scope="String"]
	[attributes="String"]
	[filter="String"]
	[filterFile="String"]
	[sort="String"]
	[sortControl="String"]
	[dn="String"]
	[startRow="number"]
	[modifyType="String"]
	[rebind="Boolean"]
	[referral="String"]
	[separator="String"]
	[delimiter="String"]
 />

[] = Optional attribute

Attributes

Name	Type	Required	Default	Description
returnAsBinary	String	No		A comma-delimited list of columns that are to be returned as binary values.
server	String	Yes		Host name "biff.upperlip.com" or IP address "192.1.2.225" of the LDAP server.
port	number	No		Port defaults to the standard LDAP port, 389.
username	String	No		If no user name is specified, the LDAP connection is anonymous.
password	String	No		used when username is defined
action	String	No		Specifies the LDAP action.
name	String	No		The name you assign to the LDAP query.
timeout	number	No		Specifies the maximum amount of time, in seconds, to wait for LDAP processing. Defaults to 60 seconds.
maxRows	number	No		Specifies the maximum number of entries for LDAP queries.
start	String	No		Specifies the distinguished name of the entry to be used to start the search.
scope	String	No		Specifies the scope of the search from the entry specified in the Start attribute for action = "Query".
attributes	String	No
filter	String	No
filterFile	String	No		Specifies the name of a filter file and of the stanza tag within the file that contains the LDAP filter string specification. You can specify an absolute pathname or a simple filename to identify the file.
sort	String	No		Indicates the attribute or attributes by which to sort query results. Use a comma to separate attributes.
sortControl	String	No		Specifies how to sort query results.
dn	String	No		Specifies the distinguished name for update actions.
startRow	number	No		Used in conjunction with action = "Query". Specifies the first row of the LDAP query to insert into the ColdFusion query. The default is 1.
modifyType	String	No		Indicates whether to add, delete, or replace an attribute in a multi-value list of attributes.
rebind	Boolean	No		If you set rebind to Yes, cfldap attempts to rebind the referral callback and reissue the query by the referred address using the original credentials. The default is No, which means referred connections are anonymous.
referral	String	No		Identifies the type of security to employ, CFSSL_BASIC or CFSSL_CLIENT_AUTH, and additional information that is required by the specified security type.
separator	String	No		Specifies the character that cfldap uses to separate attribute values in multi-value attributes. This character is used by the query, add, and modify action attributes, and by cfldap to output multi-value attributes. The default character is the comma (,).
delimiter	String	No		Specifies the character that cfldap uses to separate multiple attribute name/value pairs when more than one attribute is specified in the attribute attribute or the attribute that you want to use has the default delimiter character, which is the semicolon (;), such as mgrpmsgrejecttext;lang-en. The delimiter character is used by the query, add, and modify action attributes, and is used by cfldap to output multi-value attributes