userFindUsers( )

Finds users by name.

Pseudocode

userFindUsers(
  string userName, 
  string firstName,
  string lastName,
  unsigned int startPosition,
  unsigned int maxResults,
  unsigned int groupId,
  boolean usersNotInGroup,
  boolean adminsNotInGroup
);

Parameters

userName Search by user name.
firstName Search by a user’s first name.
lastName Search by a user’s last name.
startPosition Starting index in the database.
maxResults Maximum number of results returned.
groupId An optional group id.
usersNotInGroup Search for users not in any group.
adminsNotInGroup Search for administrators not in any group.

Returns

The information in a getFindUsersResponse structure.

Remarks

May be called multiple times to get results in chunks, by using the startPosition index. Also allows searching for users who are not in a group or are not group administrators.

Send feedback about this page using email.