$fn.createUser(param)

Add an authenticated user for the application. "asynchronous"

Note

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
param	object	User information to be registered

parameters details

Property	Type	Description
email	string	Email (string used for sign-in ID)
name	string	Name
password	string	Temporary password
sendMail	boolean	true: Send issue mail false: Do not send issue mail Default is false
custom_01	string	Custom Attribute 1
custom_02	string	Custom Attribute 2
custom_03	string	Custom Attribute 3
custom_04	string	Custom Attribute 4
custom_05	string	Custom Attribute 5
custom_06	string	Custom Attribute 6
custom_07	string	Custom Attribute 7
custom_08	string	Custom Attribute 8
custom_09	string	Custom Attribute 9
custom_10	string	Custom Attribute 10

Note

• For maximum characters and restrictions on e-mail, name, temporary password, and custom attributes, please refer to the user creation page.
• If the function is executed without setting password, a random temporary password will be set.
  If sendMail is false, it is recommended to use true because the password cannot be confirmed.
• The status of a user created by the $fn.createUser function will be Force Change Password.
• If the user’s status is Force Change Password, the user will not be able to reset password in the authentication UI until the user logs in for the first time.
• If a password reset is required, one of the following actions by the administrator is required.

1. Reset password from [User Manager]>[User Three-Point Reader]>[Reset Password]
2. Reset password from $fn.resetPassword() function

Return value

Type	Description
Promise<User>	Registered User Information

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Note

In case of an error, an error object with the following keys is returned as the return value.

• errorType
• errorMessage
• trace

Sample

try {
  /* CSV content
   * -----------------------------------------------------
   * "email","name","password","sendMail"
   * "user01@test.co.jp","User01","Password@01",true
   * "user02@test.co.jp","User02","Password@02",false
   * -----------------------------------------------------
   */
     const file = await $fn.getFile('/userInfo.csv');
     const buffer = file.data;
     const userInfos = $fn.csvToObject(buffer);
     for (let userInfo of userInfos) {
         console.log(JSON.stringify(userInfo));
         let data = {};
         data = {
             email: userInfo['email'],
             name: userInfo['name'],
             password: userInfo['password'],
             sendMail: JSON.parse(userInfo['sendMail'])
         };
         // Add User
         let result=await $fn.createUser(data);
         if(result.errorType){
           throw new Error (result.errorMessage);
     }
      }
} catch(err) {
    console.log("Error", err.message);
}