$fn.getGroups(option)

Retrieves all groups that exist in the user manager. "asynchronous"

Note

• Since this is an asynchronous function, an await expression is required at call time.
• The group name "Global" cannot be obtained.

Arguments

Name	Type	Description
option	object	Specify whether to include invalid users

Option Details

Name	Type	Description
containUsers	boolean	true: Include users belonging to the group false: Do not include users belonging to the group Default is true

Return value

Type	Description
Promise<Group[]>	Group list

Object	Property	Type	Description
Group	groupName	string	Group Name
	description	string	Description
	members	object array	Active user array belonging to group

Sample

try {
    // Obtain group information not including users belonging to the group
    const groups = await $fn.getGroups({containUsers:false});
    console.log(groups);
} catch (err) {
    console.log("Error", err);
}