$fn.listUsersByName(name,option)

Performs a forward match search by user name to retrieve users present in the user manager. "asynchronous"

Note

• As this is an asynchronous function, an await expression is required at call time.
• If there are more than 60 users matching the search criteria, the time required to retrieve data with the listUsersByName function will increase in proportion to 60.

Arguments

Name	Type	Description
name	String	Search string
option	object	specify whether to include invalid users

Option details

Name	Type	Description
disabled	boolean	true: Include disabled users false: Do not include invalid users Default is false

Note

If name is empty, all users in the execution environment are returned.
Whether invalid users are included or not depends on the option specified.

Return value

Type	Description
Promise<User[]>	List of users matching the criteria

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	User Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Sample

try {
  const name = $ui.searchKey.value;
  // Display search results in table with table columns "userId", "email", and "name"
  $ui.userList.value = await $fn.listUsersByName(name,{disabled:true});
} catch(err) {
 console.log("Error", err);
}