ldapUserRecord

Starting with katl-commons 3.0, this syntax is deprecated and you should use the new alias name: ldapUserAttr instead.

Availability

This routine is available starting with katl-commons 1.0, changed in 1.1.15 for Jira 4.3.x/4.4.x and katl-commons 2.0.8 for Jira 5.x.

Syntax

ldapUserRecord(attrib, ldapQuery)

or (deprecated form)

ldapUserRecord(attrib, cn, dn, memberof, email, ldapObjectClass)

Description

Returns an array of the requested attribute. This is a LDAP search routine.

The second routine syntax is more comfortable. Both get the LDAP record and shows the attribute of that user. Returned user must be unique, otherwise exception occurs.

Parameters

Parameter name	Type	Required	Description
attrib	string	yes	Attribute to be returned.
ldapQuery	string	yes	Query, must return exactly one result.

Allowed attributes are (these are case sensitive):

CN
DN
firstName
lastName
displayName
title
department
division
officeName (mapped on physicalDeliveryOfficeName attribute)
company
empID
manager
mail
otherMailbox
mobile
homePhone
workPhone
userPrincipalName
winPrincipalName

Tip

Starting with katl-commons 1.1.15 and 2.0.8, you can retrieve any attribute defined in the scheme.

Returns

string []

The values of the specified attribute. 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.

Example

ldapUserRecord("mobile", user, "", "", "", "user");
//gets the mobile attribute from LDAP user with specified CN

OpenDS example

string email = ldapUserRecord("mail", "(&(uid=user.1)(objectClass=inetOrgPerson))");
string address = ldapUserRecord("postalAddress", "(&(uid=user.1)(objectClass=inetOrgPerson))");

Notes

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.