...
...
| Info | ||
|---|---|---|
| ||
This routine is available since starting with katl-commons 3.0. |
Syntax
...
ldapUserStruct(ldapQuery[, ldapName])
Description
...
| Excerpt |
|---|
Returns an array of JLdapUserStruct representing all users matched by the query. |
Parameters
...
Parameter name | Type | Required | Description |
|---|---|---|---|
ldapQuery | string | yes | the query, must return exactly one result |
| ldapName | string | no | Optional, from version 4.0, you can specify which LDAP server must be searched. If missing, it's the default LDAP server |
Returns
...
JLdapUserStruct []
Each element in the array represents an user. The attributes field of the JLdapUserStruct is also keyed by the attribute name for easy access of attributes. Each attribute is a JLdapUserAttribute. The "value" field of the attribute is a string array. If the attribute only has one value, the array will contain only one element, but will still be an array and not a single string.
OpenDS Example
...
| Code Block |
|---|
JLdapUserStruct [] users = ldapUserStruct("objectClass=inetOrgPerson");
for(JLdapUserStruct u in users) {
print(u.DN);
for(JLdapUserAttribute attr in u.attributes) {
print(attr.name + " = " + attr.value);
}
print("ID is : " + u.attributes["uid"].value);
} |
Notes
...
| Note |
|---|
LDAP must be configured (see LDAP Configuration page). |
...
| Warning |
|---|
Only Microsoft Active Directory is supported at this time, but it might work with others as well (tested with OpenDS). To provide support for other LDAP types, please contact us. |
See
...
also
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|