Skip to end of metadata
Go to start of metadata

Cprime Apps has been rebranded as Anova Apps. Please note the only effect is the company name - all of our products’ names, logos, functionalities, support, etc. is exactly the same. The new location to our documentation space is


This routine is available starting with SIL Engine™ 2.5.15 for Jira 5.x and 2.6.7 for Jira 6.x.


ldapUserList(attributes, ldapQuery[, ldapName])


Returns an array of the requested attributes for all users matching the query. This is an LDAP search routine.


Parameter name





string []


Attributes to be returned.





ldapNamestringnoLDAP server name that you have configured. If missing, it directs the query to the default LDAP server. This parameter appears at version 4.0.


string []

The values of the attributes for all users in multiples of N, where N is the number of requested attributes.
The length of the returned array will be N x M. N = number of attributes requested, M = number of users matching the query. Therefore, element at index i is the value of the attribute at position i%N from the attributes array for the (i/N)th user matching the query.


return ldapUserList({"cn", "uid"}, "objectClass=inetOrgPerson");
//example return value: Aaron Atrc|user.3|Aarika Atpco|user.2|Aaren Atp|user.1|Aartjan Aalders|user.4|Aaccf Amar|user.0

// contains cn,uid for the 5 users matching the filter: cn1,uid1,cn2,uid2,cn3,uid3 ...

Instead of exploiting the result as an array of strings, you may map it on some structure. Following code represents the above example:

struct mystruct {
  string cn;
  string uid;

mystruct [] arr = ldapUserList({"cn", "uid"}, "objectClass=inetOrgPerson"); 

//now you can access it by:
string x = arr[0].cn; //life is better, huh ?

You can use this routine with the User Group Picker PRO.

Example script for SIL User Picker:

return ldapUserList({"uid"}, "(&(objectClass=inetOrgPerson)(isMemberOf=cn=group-one,dc=example,dc=com))");


LDAP must be configured. See LDAP configuration page.

Only Microsoft Active Directory is supported at this time, but it might work with other as well (tested with OpenDS). To provide support for other LDAP types contact us.

See also