$fn.listUsersByName(name,option)

ユーザ名による前方一致検索をし、ユーザマネージャに存在するユーザを取得します。[非同期]

ノート

• 非同期関数であるため、コール時にawait式が必要になります。
• 検索条件に一致するユーザが60人以上いる場合、listUsersByName関数でデータ取得に要する時間が60に比例して増えていきます。

引数

名前	型	説明
name	String	検索文字列
option	object	無効ユーザを含めるか指定

option詳細

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

ノート

nameが空の場合、実行環境のユーザをすべて返します。 無効ユーザを含めるか否かはoptionの指定に従います。

戻り値

型	説明
Promise<User[]>	条件に一致するユーザリスト

オブジェク	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	ユーザ名
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
  const name = $ui.searchKey.value;
  // テーブルカラム「userId」「email」「name」があるテーブルに検索結果を表示
  $ui.userList.value = await $fn.listUsersByName(name,{disabled:true});
} catch(err) {
 console.log("Error", err);
}