{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The LDAP functions allow you to connect to an LDAP, using anonymous or simple authentication, and modify and delete entries or perform searches based on names, filters and explicitly define what attributes to be returned. The LDAP functions use connection pooling for best performance.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note!","type":"text"}]},{"type":"paragraph","content":[{"text":"Due to the nature of LDAP, the following functions are not transaction safe and should therefore be used mainly for realtime workflows.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The following functions for LDAP described here are:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"1"},"include":{"value":"ldap.*"}},"macroMetadata":{"macroId":{"value":"957b5f99-8f96-4305-bc0b-aa3ad0ab38e8"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"LDAP Related UDR Type","type":"text"}]},{"type":"paragraph","content":[{"text":"The UDR type created by default in the LDAP agent can be viewed in the UDR Internal Format Browser. To open the browser open an APL Editor, in the editing area right-click and select ","type":"text"},{"text":"UDR Assistance...","type":"text"},{"text":"; the browser opens.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Error Handling","type":"text"}]},{"type":"paragraph","content":[{"text":"The default error handling for the functions ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"ldapSearch","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"ldapScopeSearch","type":"text","marks":[{"type":"code"}]},{"text":" is to handle all errors as exceptions, which means that the workflow will abort in the batch case and the request will typically be discarded in the real-time case.","type":"text"}]},{"type":"paragraph","content":[{"text":"If this is not desired behavior, it is possible to set these LDAP functions to suppress all communication errors and instead return ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":" in error situations. In this case, the error will be made available through the ","type":"text"},{"text":"ldapGetLastError","type":"text","marks":[{"type":"code"}]},{"text":" function.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Network Timeout Property","type":"text"}]},{"type":"paragraph","content":[{"text":"If there are network problems when communicating with the LDAP server the LDAP plugin commands use a network timeout of 5 minutes. This default timeout can be modified by setting the property ","type":"text"},{"text":"mz.ldap.network.timeout","type":"text","marks":[{"type":"code"}]},{"text":" to a timeout in milliseconds.","type":"text"}]},{"type":"paragraph","content":[{"text":"Set the property in the ","type":"text"},{"text":"cell.conf","type":"text","marks":[{"type":"code"}]},{"text":" or the relevant Execution Context ","type":"text"},{"text":".conf","type":"text","marks":[{"type":"code"}]},{"text":", depending on where the workflow is executed.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Idle Connection Timeout","type":"text"}]},{"type":"paragraph","content":[{"text":"By default, a connection remains within a pool in an idle state for five minutes before it is closed. To set the amount of time in milliseconds, set the property ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#1d1c1d"}}]},{"text":"com.sun.jndi.ldap.connect.pool.timeout","type":"text","marks":[{"type":"code"}]},{"text":" in the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#1d1c1d"}}]},{"text":"cell.conf","type":"text","marks":[{"type":"code"}]},{"text":" or the relevant Execution Context ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#1d1c1d"}}]},{"text":".conf","type":"text","marks":[{"type":"code"}]},{"text":", depending on where the workflow is executed","type":"text","marks":[{"type":"textColor","attrs":{"color":"#1d1c1d"}}]},{"text":".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#1d1c1d"}}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapCreate","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a connection towards an LDAP server, using either anonymous or simple authentication. This function is usually invoked in the ","type":"text"},{"text":"initialize","type":"text","marks":[{"type":"code"}]},{"text":" block.","type":"text"}]},{"type":"codeBlock","content":[{"text":"any ldapCreate\n ( string host , \n int port , \n string name ,\n string principal , //Optional\n string credentials ) //Optional","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"host","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The host name of the LDAP server","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The port number of the LDAP server","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name which identifies the context in which the search will be performed. The value can span multiple naming systems and must be fully qualified and identify entries from the root of the LDAP server. If specified as ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":" this means that the search will be performed from the LDAP root.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"principal","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional argument that defines the user to connect as. If omitted, the function will connect to the LDAP server using anonymous authentication. This argument requires that the credentials argument is supplied.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"credentials","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional argument that defines the user password.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An identifier used when invoking the search function.","type":"text"}]},{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"ldapSuppressErrors","type":"text","marks":[{"type":"code"}]},{"text":" has been called, then this function returns null if an error is detected during communication with the LDAP server. ","type":"text"},{"text":"ldapGetLastError","type":"text","marks":[{"type":"code"}]},{"text":" should be used to get the error message in this case.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using ldapCreate","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"any ctx = ldapCreate(\"10.0.0.1\", 389, \"o=users\");\n...\nany ctx = ldapCreate(\"10.0.0.1\", 389, \"o=users\", \n \"cn=Administrator, o=users\", \"secret\");","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapAdd","type":"text"}]},{"type":"paragraph","content":[{"text":"The command is used to add an entry.","type":"text"}]},{"type":"codeBlock","content":[{"text":"string ldapAdd\n ( any identifier , \n string name , \n list attributes )","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The connection identifier returned from ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the entry to add. This is matched relative to the context specified with the ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" argument in ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":". If no object matches the name, an error will be thrown stating there is no such name.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"attributes","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The new attribute value. If a delete operation is requested, the matching value is deleted.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"In the event of an error, a message from LDAP server will be returned otherwise null.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapCloseCtx","type":"text"}]},{"type":"paragraph","content":[{"text":"The command is used to close a context that has previously been returned by ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"int ldapCloseCtx\n ( object context )","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"context","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The context returned from ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"If the function is successful, it will return 0.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapDelete","type":"text"}]},{"type":"paragraph","content":[{"text":"An APL command used to delete an entry.","type":"text"}]},{"type":"codeBlock","content":[{"text":"string ldapDelete\n ( any identifier , \n string name )","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The connection identifier returned from ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the entry to be deleted.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"In the event of an error, a message from LDAP server will be returned otherwise null.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapGetLastError","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves the error message of the last error reported for an LDAP command.","type":"text"}]},{"type":"codeBlock","content":[{"text":"string ldapGetLastError()","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The last error message that an LDAP function registered. This information is kept per thread and agent so it is only guaranteed to be present in the same APL code block as the function call causing the error.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapModify","type":"text"}]},{"type":"paragraph","content":[{"text":"An APL command used for modifying an entry by adding, replacing or deleting its attributes.","type":"text"}]},{"type":"codeBlock","content":[{"text":"string ldapModify\n ( any identifier , \n string name , \n string operation ,\n list attributeValue ) //Optional","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The connection identifier returned from ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the entry to modify","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"operation","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The operation can be either ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"ADD","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"REMOVE","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" or ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"REPLACE","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"attributeValue","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of new attribute values. If a ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"REMOVE","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" operation is requested, the matching values are deleted.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"In the event of an error, a message from LDAP server will be returned otherwise null.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapSearch","type":"text"}]},{"type":"paragraph","content":[{"text":"Performs a search in a LDAP server based on a number of arguments.","type":"text"}]},{"type":"codeBlock","content":[{"text":"list ldapSearch\n ( any identifier , \n string name , \n string filter , //Optional\n list retAttrs ) //Optional","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The connection identifier returned from ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the object to be searched for. This is matched relative to the context specified with the ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" argument in ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":". If no object matches the name, an error will be thrown stating there is no such name.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"filter","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional value, specifying the attributes of the requested LDAP objects. This value conforms to RFC 2254. The specified filter will match objects, relative to the ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" parameter.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"retAttrs","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional list of strings that defines what attributes to be returned","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A list of ","type":"text"},{"text":"ldapResult","type":"text","marks":[{"type":"code"}]},{"text":" UDRs, where every entry contains a name, an attribute and a list of values. The name value is the name relative to the target context of the search. If the target context matches the search filter, then the returned name will be an empty string. The attribute is the attribute name and the values are all values for the given attribute.","type":"text"}]},{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"ldapSuppressErrors","type":"text","marks":[{"type":"code"}]},{"text":" has been called, then this function returns null if an error is detected during communication with the LDAP server. ","type":"text"},{"text":"ldapGetLastError","type":"text","marks":[{"type":"code"}]},{"text":" should be used to get the error message in this case.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapScopeSearch","type":"text"}]},{"type":"paragraph","content":[{"text":"Performs a search in a specified part of the LDAP server based on a number of arguments.","type":"text"}]},{"type":"codeBlock","content":[{"text":"list ldapScopeSearch\n ( any identifier , \n string scope ,\n string name ,\n string filter , //Optional\n list retAttrs ) //Optional","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The connection identifier returned from ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"scope","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The search scope, can be one of ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"OBJECT_SCOPE","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"ONELEVEL_SCOPE","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" or ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"SUBTREE_SCOPE","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":". For further information, see your LDAP manual.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the object to be searched for. This is matched relative to the context specified with the ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" argument in ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":". If no object matches the name, an error will be thrown stating there is no such name.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"filter","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional value, specifying the attributes of the requested LDAP objects. This value conforms to RFC 2254. The specified filter will match objects, relative to the ","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":" parameter.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"retAttrs","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional list of strings that defines what attributes to be returned","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A list of ","type":"text"},{"text":"ldapResult","type":"text","marks":[{"type":"code"}]},{"text":" UDRs, where every entry contains a name, an attribute and a list of values. The name value is the name relative to the target context of the search. If the target context matches the search filter, then the returned name will be an empty string. The attribute is the attribute name and the values are all values for the given attribute.","type":"text"}]},{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"ldapSuppressErrors","type":"text","marks":[{"type":"code"}]},{"text":" has been called, then this function returns null if an error is detected during communication with the LDAP server. ","type":"text"},{"text":"ldapGetLastError","type":"text","marks":[{"type":"code"}]},{"text":" should be used to get the error message in this case.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapSetPooling","type":"text"}]},{"type":"paragraph","content":[{"text":"The command is used to enable/disable connection pooling. Pooling is enabled by default.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void ldapSetPooling ( boolean value )","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"value","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The value should be set to either ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The function returns nothing.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ldapSuppressErrors","type":"text"}]},{"type":"paragraph","content":[{"text":"An APL command used to change the error behavior of the other LDAP functions.","type":"text"}]},{"type":"paragraph","content":[{"text":"This function only changes the error behavior of the functions ","type":"text"},{"text":"ldapCreate","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"ldapSearch","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"ldapScopeSearch","type":"text","marks":[{"type":"code"}]},{"text":". It does not suppress errors for configuration errors (such as the user using invalid input for the function calls).","type":"text"}]},{"type":"codeBlock","content":[{"text":"void ldapSuppressErrors\n ( boolean value )","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Descriptionn","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"value","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Whether or not errors should be suppressed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - LDAP APL Plugins","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"// Demonstration of LDAP APL plugin functions\n\n// The following code shows the following:\n//\n// 1) How to open a LDAP connection\n// 2) How to add/delete an object to/from LDAP\n// 3) How to change objects properties\n// 4) How to perform different type of searches\n\nvoid runDemoCode() {\n\n any ctx;\n string name = \"DEMOUSER\";\n string distinguisedName = \"cn=\"+name;\n string error;\n list attributes;\n list result;\n\n // ==============================================\n // Opens a connection to a LDAP Server\n // ==============================================\n ctx = ldapCreate(\"127.0.0.1\", 389, \"dc=nodomain\",\n \"cn=admin,dc=nodomain\", \"demo\"); \n \n // ==============================================\n // Adding/Deleting/Modifying an LDAP Object\n // ==============================================\n \n //\n //Adds a new person object to the LDAP Server\n //\n attributes = listCreate(string);\n listAdd(attributes, \"cn: \"+name);\n listAdd(attributes, \"objectClass: top\");\n listAdd(attributes, \"objectClass: person\");\n listAdd(attributes, \"sn: Test\");\n listAdd(attributes, \"description: Test Record\");\n listAdd(attributes, \"userPassword: {crypt}rkM1sTbxrERtE\");\n \n error = ldapAdd(ctx, distinguisedName, attributes);\n if( error != null ) {\n debug(\"Error creating user: \"+error);\n }\n \n //\n //Changes description for the created person object\n //\n attributes = listCreate(string);\n listAdd(attributes, \"description: A demo user\");\n \n error = ldapModify(ctx, distinguisedName, \"REPLACE\", \n attributes);\n if( error != null ) {\n debug(\"Error changing user description: \"+error);\n }\n \n //\n //Removes user description from our person object\n //\n \n attributes = listCreate(string);\n listAdd(attributes, \"description: A demo user\");\n \n error = ldapModify(ctx, distinguisedName, \"REMOVE\", \n attributes);\n if( error != null ) {\n debug(\"Error removing user description: \"+error);\n }\n \n //\n //Adds user description to our person object\n //\n attributes = listCreate(string);\n listAdd(attributes, \"description: a description line\");\n \n error = ldapModify(ctx, distinguisedName, \"ADD\", \n attributes);\n if( error != null ) {\n debug(\"Error adding user description: \"+error);\n }\n \n //\n // Deletes our person object from the LDAP Server\n //\n error = ldapDelete(ctx, distinguisedName);\n if( error != null ) {\n debug(\"Error deleting user: \"+error);\n }\n \n // ==============================================\n // Executing different searches against the LDAP\n // ==============================================\n\n // For demo purposes the LDAP tree should contain\n // two admin objects (a tree containing a backup\n // admin object).\n \n // Setup a filter for the search tests.\n // We are interested only in the attribute 'cn'.\n //\n list attrFilter = listCreate(string);\n listAdd(attrFilter, \"cn\");\n \n //\n //Executes a normal search, should return size=1\n //\n result = ldapSearch(ctx, \"dc=test\", \"cn=admin\", attrFilter);\n debug(\"* Normal search\");\n debug(\"result size=\"+listSize(result));\n printResultEntries(result);\n \n //\n //Scoped Search Types\n //\n //This search uses OBJECT scope, and should return size=1\n // Explanation:\n // The search only searches for a specific object, and the \n // 'cn' attribute is returned for that object.\n //\n result = ldapScopeSearch(ctx, \"OBJECT_SCOPE\", \"dc=test\", \n \"cn=admin\", attrFilter);\n debug(\"* Object Scope\");\n debug(\"result size=\"+listSize(result));\n printResultEntries(result);\n \n //\n //This search uses ONELEVEL scope, and should return size=1.\n //\n // Explanation:\n // The search executes a search on a unique level. Two objects\n // with the same name can not exists on the same level.\n //\n result = ldapScopeSearch(ctx, \"ONELEVEL_SCOPE\", \"dc=test\",\n \"cn=admin\", attrFilter);\n debug(\"* Onelevel Scope\");\n debug(\"result size=\"+listSize(result));\n printResultEntries(result);\n \n //\n //This search uses SUBTREE scope, and should return size=2.\n //\n // Explanation:\n // The search execute a search on sublevels, and return a\n // match for every admin object found (and we had two).\n //\n result = ldapScopeSearch(ctx, \"SUBTREE_SCOPE\", \"dc=test\",\n \"cn=admin\", attrFilter);\n debug(\"* Subtree Scope\");\n debug(\"result size=\"+listSize(result));\n printResultEntries(result);\n}\n \n//\n// Help method that prints out the result of a ldapSearch\n//\n\nvoid printResultEntries(list result)\n{\n int resultIdx = 0;\n int resultCount = 0;\n int resultSize = listSize(result);\n while (resultCount < resultSize) {\n ldapResult entry = listGet(result, resultCount);\n debug(\"Name: \" + entry.name);\n debug(\"Attribute: \" + entry.attribute);\n int valueCount = 0;\n int valueSize = listSize(entry.values);\n while (valueCount < valueSize){\n debug(\"Value: \" + listGet(entry.values, valueCount));\n valueCount = valueCount + 1;\n }\n resultCount = resultCount + 1;\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"scroll-pagebreak","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"6b903906-c39f-4475-9a58-c091860b2ec3"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://scroll-exporter-extensions.us.exporter.k15t.app/static/assets/images/macro-icons/scroll-pagebreak.svg"}}],"title":"Scroll Pagebreak"}}}}],"version":1}

Browser not supported