コンテンツにスキップ

$fn.getUsers(groupName?,option)

ユーザマネージャに存在するユーザを取得します。[非同期]

引数

名前説明
groupName?stringユーザ抽出条件のグループ名
optionobject無効ユーザを含めるか指定

option詳細

名前説明
disabledbooleantrue: 無効ユーザを含める
false: 無効ユーザを含めない
デフォルトはfalse

戻り値

説明
Promise<User[]>条件に一致するユーザリスト
オブジェクトプロパティ説明
UseruserIdstringユーザID (GUID)
emailstringEメール
namestringユーザ名
custom_01stringカスタム属性1
custom_02stringカスタム属性2
custom_03stringカスタム属性3
custom_04stringカスタム属性4
custom_05stringカスタム属性5
custom_06stringカスタム属性6
custom_07stringカスタム属性7
custom_08stringカスタム属性8
custom_09stringカスタム属性9
custom_10stringカスタム属性10
enabledboolean有効/無効
createdstring作成日時
updatedstring更新日時
statusstringユーザのステータス

サンプル

try {
const users = await $fn.getUsers('group1',{disabled:true});
} catch (err) {
console.log("Error", err)
}