On This Page
LDAP Server Attributes
This is the list of LDAP server attributes required for any custom LDAP configuration:
|
attr_objective |
attr_name (Example) |
Attribute Description |
Required/ Optional |
|---|---|---|---|
|
userIdAttributeNames |
cn |
The username field of a user account (Can include multiple values; Separate with comma or space) |
Required |
|
mailAttributeName |
|
The email address field of a user account |
Required |
|
firstNameAttributeName |
givenName |
The first name field of a user account |
Required |
|
lastNameAttributeName |
sn |
The last name field of a user account |
Required |
|
objectClassAttributeName |
objectClass |
The name of the LDAP attribute that contains the object class |
Required |
|
userObjectSearchAttributeNames |
cn |
The name of the LDAP attribute that is used to search for users (Can include multiple values; Separate with comma or space) |
Required |
|
userObjectClassAttributeNames |
organizationalPerson |
The name of the LDAP class that contains users (Can include multiple values; Separate with comma or space) |
Required |
|
userObjectCustomLdapQuery |
(sAMAccountType=805306368) |
The custom LDAP query that is used to search for the LDAP Class of users (Overrides userObjectClassAttributeNames) |
Optional |
|
commonNameAttributeName |
cn |
The common name field of a user account |
Required |
|
displayNameAttributeName |
cn |
The display name field of a user account |
Required |
|
userManagerDnAttributeName |
manager |
The name of LDAP attribute of a user account that contains a manager DN |
Required |
|
groupMembersAttributeName |
uniqueMember |
The name of the LDAP attribute that contains members of group |
Required |
|
groupObjectSearchAttributeNames |
cn |
The name of the LDAP attribute that is used to search for groups (Can include multiple values; Separate with comma or space) |
Required |
|
groupObjectClassAttributeNames |
orclGroup |
The name of the LDAP class that contains groups (Can include multiple values; Separate with comma or space) |
Required |
|
groupObjectCustomLdapQuery |
The custom LDAP query that is used to search for the LDAP Class of groups (Overrides groupObjectClassAttributeNames) |
Optional |
|
|
groupMailAttributeName |
|
The email address field of a group |
Required |
|
groupCommonNameAttributeName |
cn |
The common name field of a group |
Required |
|
groupDisplayNameAttributeName |
cn |
The display name field of a group |
Required |
|
ouObjectSearchAttributeNames |
cn |
The name of the LDAP attribute that is used to search for organizational units (Can include multiple values; Separate with comma or space) |
Required |
|
ouObjectClassAttributeNames |
orclContainer, orclSubscriber, orclContext |
The name of the LDAP class that contains organization units (Can include multiple values; Separate with comma or space) |
Required |
|
ouObjectCustomLdapQuery |
The custom LDAP query that is used to search for the LDAP Class of organizational units (Overrides ouObjectClassAttributeNames) |
Optional |
|
|
ouMailAttributeName |
|
The email address field of a organization unit |
Required |
|
ouCommonNameAttributeName |
cn |
The common name field of a organization unit |
Required |
|
ouDisplayNameAttributeName |
cn |
The display name field of a organization unit |
Required |
|
uniqueIdAttributeName |
cn |
Unique identifier attribute for the user (Do not change the unique identifier attribute after the LDAP server support is added) Note: Ignored if isSupportsQueryById is False |
Required |
|
isSupportsBrowsing |
true |
False – Results are not shown in the LDAP browser (Cannot search for objects in LDAP) True – Results are shown in the LDAP browser |
Required |
|
isSupportsPaging |
true |
False – Results in the LDAP browser are not shown in paged groups True – Results in the LDAP browser are shown in paged groups |
Required |
|
isSupportsQueryById |
false |
False – Do not query for results by UID True – Query for results by UID (Requires value for uniqueIdAttributeName) |
Required |
