$fn.updateUser(param)

アプリケーションの認証ユーザを更新します。[非同期]

ノート

• 非同期関数であるため、コール時にawait式が必要になります。
• 外部認証ユーザを更新することはできません。

引数

名前	型	説明
param	object	更新するユーザ情報

param詳細

プロパティ	型	説明
originalEmail	string	Eメール（更新前）
email	string	Eメール（更新後）
name	string	名前
enabled	boolean	true：有効 false：無効 デフォルトはtrue
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

ノート

Eメールを変更しない場合は[originalEmail], [email]両方同じメールアドレスを設定してください。

戻り値

型	説明
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 {
  /* CSV の内容
   * ---------------------------------------------------------
   * "originalEmail","email","name","enabled"
   * "user01@test.co.jp","user01@test.co.jp","User01",ture
   * "user02@test.co.jp","user02@test.co.jp","User02",false
   * ---------------------------------------------------------
   */
    const file = await $fn.getFile('/updateUserInfo.csv');
    const buffer = file.data;
    const userInfos = $fn.csvToObject(buffer);
    for (let userInfo of userInfos) {
        let data = {};
        data = {
            originalEmail: userInfo['originalEmail'],
            email: userInfo['email'],
            name: userInfo['name'],
            enabled: JSON.parse(userInfo['enabled'])
        };
        // ユーザ更新
        const result = await $fn.updateUser(data);
  }
} catch(err) {
    console.log("Error", err);
}