core_v2_ldapUsers Script API

Enables scripted content fragments to access LDAP Users

List

Methods

List

List Overload 1

Searches for LDAP users

Velocity

#set($pagedListResponse = $core_v2_ldapUsers.List($usernameQuery))

JavaScript

var pagedListResponse = core_v2_ldapUsers.List(usernameQuery);

Parameters

Name	Type	Description	Required	Default	Options
usernameQuery	`String`	Username Query	Required

List Overload 2

Searches for LDAP users

Velocity

#set($pagedListResponse = $core_v2_ldapUsers.List("%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UsernameQuery = $usernameQueryArg }"))

JavaScript

var pagedListResponse = core_v2_ldapUsers.List({ PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, UsernameQuery: usernameQueryArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
SortBy	`String`	Sort By	Optional	JoinedDate	ContentIdsOrder, DisplayName, Email, JoinedDate, LastVisitedDate, Posts, RecentPosts, Score, Username, Website
SortOrder	`String`	Sort Order	Optional	Ascending	Ascending, Descending
UsernameQuery	`String`	Username Query	Optional

Returns

PagedList of LdapUser