...
| Excerpt |
|---|
Returns an array of the requested attributes for all users matching the query. This is a an LDAP search routine. |
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
attributes | string [] | yes | the attributes Attributes to be returned. |
ldapQuery | string | yesthe | queryQuery. |
| ldapName | string | no | the LDAP server name that you have configured. If missing, it directs the query to the default LDAP server. This parameter appears at version 4.0. |
Returns
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, such that element at index i is the value of the attribute at position i%N from the attributes array , for the (i/N)th th user matching the query.
Example
...
| Code Block |
|---|
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. For Following code represents the above example:
| Code Block |
|---|
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 ? |
...
| Note |
|---|
LDAP must be configured (see . See LDAP configuration page). |
| Warning |
|---|
Only Microsoft Active Directory is supported at this time, but it might work with others other as well (tested with OpenDS). To provide support for other LDAP types , please contact us. |
See also
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...