Previous Topic: Sort CriteriaNext Topic: Examples


Output Parameters

UserAccounts

This is an array of value maps, where each value map contains the attributes retrieved for the user. This variable is created only when the operation succeeds.

LDAPSearchPath
LDAPSearchScope
ResultsLimit
LDAPGetTimeLimit
LDAPGetFilter
LDAPGetAttributesType
LDAPGetAttributesArray
LDAPGetAttributes
LDAPGetSortAttributesType
LDAPGetSortAttributesArray
LDAPGetSortAttributes
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix

Attribute names entered in the sort and retrieve sections must be the LDAP names of these attributes as specified in the LDAP server schema. For instance, to retrieve the attribute "Last name" you must use the LDAP name of this attribute: "sn", to retrieve the attribute "First Name", you must use the attribute "givenname", and so on. For more information, see the topic "Common LDAP Attribute Names".

LDAP names are different from the attributes display names.

Most LDAP servers differ in the display names of the LDAP attributes, but they all must support the LDAP names of these attributes, thus the reason why we require the usage of the LDAP names of the attributes instead of the display names.

You must provide the names of the attributes to be retrieved; otherwise CA Process Automation will not return any data in the UserAccounts variable.

If no user accounts were found under the specified search path, the search operation will succeed and the UserAccounts variable will be empty. The search operation will not fail in this case.