$fn.getGroups(option)

ユーザマネージャに存在するすべてのグループを取得します。[非同期]

ノート

• 非同期関数であるため、コール時にawait式が必要になります。
• グループ名「Global」は取得できません。

引数

名前	型	説明
option	object	グループに所属するユーザを含めるか指定

option詳細

名前	型	説明
containUsers	boolean	true: グループに所属するユーザを含める false: グループに所属するユーザを含めない デフォルトはtrue

戻り値

型	説明
Promise<Group[]>	グループリスト

オブジェクト	プロパティ	型	説明
Group	groupName	string	グループ名
	description	string	説明
	members	object array	グループに所属するアクティブユーザ配列

サンプル

try {
    // グループに所属するユーザを含めないグループ情報を取得
    const groups = await $fn.getGroups({containUsers:false});
    console.log(groups);
} catch (err) {
    console.log("Error", err);
}