Integration Server 10.11 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client.ldap:modify
 
pub.client.ldap:modify
WmPublic. Performs an LDAP modify operation that allows you to specify a list of attributes with corresponding lists of values to add to, replace, or remove from the directory entry.
Input Parameters
url
String Optional. URL of the LDAP server to connect to.
principal
String Optional. The principal for the LDAP server.
credentials
String Optional. Credentials for the LDAP server.
timeout
String Optional. Connection timeout in milliseconds.
The default value is 30000 milliseconds.
ldapEnv
Record Optional. Key/value parameters to be passed to JNDI to further define the connection environment. See your JNDI provider documentation or the Oracle JNDI documentation for more information about parameters you can pass to JNDI.
close
String Flag that specifies whether to close the connection after the service finishes. Set to:
*yes to close the connection. This is the default.
*no to leave the connection open and available.
dn
String The distinguished name of the entry to modify.
connectionHandle
Object Optional. Connection object returned by a previously invoked LDAP service.
attrs
Document List Optional. For each LDAP attribute to change, specifies the attribute name, the values affected, and the action to perform on those values. The following example shows how to specify the removal of John Smith's nickname Johnny.
Output Parameters
connectionHandle
Object Optional. The returned connection object. Returned only if the close parameter is set to "no".
Usage Notes
When close is set to yes, Integration Server removes the connectionHandle from the pipeline, but does not close the LDAP connection. To close the LDAP connection, set the watt.server.ldap.cleanContext server configuration parameter to true. For information about the watt.server.ldap.cleanContext server configuration parameter, see webMethods Integration Server Administrator’s Guide.