User Management
Updated on Sep 22, 2022 3 minutes to readCreate User
Syntax:
E8App.$user.create(<data>, <params - optional>)
Description:
Creates a user account according to the provided parameters.
Parameters:
<data> - required
Type: Object
User profile data.
{username: <string>, email: <string>, forcePasswordChange: <Boolean>, password: <string>}
<params> - optional
Type: Object
Additional user account data.
{generateAccessToken: <Boolean>, sendWelcomeMessage: <Boolean>}
Returned value:
User account information.
Type: Object.
Find User by Id
Syntax:
E8App.$user.findById(<userId>)
Description:
Finds a user account based on the provided id.
Parameters:
<userId> - required
Type: Number
User account id.
Returned value:
False - user not found
Type: Boolean
User account information - user account found.
Type: Object.
Update User
Syntax:
E8App.$user.update(<data>, <params - optional>)
Description:
Updates a user account according with the provided parameters.
Parameters:
<data> - required
Type: Object
User profile data.
{username: <string>, email: <string>, forcePasswordChange: <Boolean>, password: <string>}
<params> - optional
Type: Object
Additional user account data.
{generateAccessToken: <Boolean>, sendWelcomeMessage: <Boolean>}
Returned value:
User account information.
Type: Object.
Delete User
Syntax:
E8App.$user.delete(<userId>)
Description:
Deletes a user account based on the provided id.
Parameters:
<userId> - required
Type: Number
User account id.
Returned value:
True - successfully deleted, False - errors occurred.
Type: Boolean.
Assign Security Roles to User Account
Syntax:
E8App.$user.assignRoles(<userId>, <roles>)
Description:
Assigns security roles to a user account.
Parameters:
<userId> - required
Type: Number
User profile id.
<roles> - required
Type: Array of strings
Array with desired security roles.
Returned value:
True - successfully assigned, False - errors occurred.
Type: Boolean.
Revoke Security Roles from User Account
Syntax:
E8App.$user.revokeRoles(<userId>, <roles>)
Description:
Revokes security roles from a user account.
Parameters:
<userId> - required
Type: Number
User profile id.
<roles> - required
Type: Array of strings
Array with desired security roles.
Returned value:
True - successfully revoked, False - errors occurred.
Type: Boolean.
Get Security Roles for User Account
Syntax:
E8App.$user.getAllRoles(<userId>)
Description:
Gets all security roles for a user account.
Parameters:
<userId> - required
Type: Number
User profile id.
Returned value:
Security roles array.
Type: Array of strings.
Block User Profile
Syntax:
E8App.$user.block(<userId>)
Description:
Blocks user account.
Parameters:
<userId> - required
Type: Number
User account id.
Returned value:
True - successfully blocked, False - Errors occurred.
Unblock User Account
Syntax:
E8App.$user.unblock(<userId>)
Description:
Unblocks user account.
Parameters:
<userId> - required
Type: Number
User account id.
Returned value:
True - successfully unblocked, False - Errors occurred.
Update User Profile
Syntax:
E8App.$user.updateProfile(<userId>, <data>)
Description:
Updates a user profile according to the provided parameters.
Parameters:
<userId> - required
Type: Number
User profile id.
<data> - optional
Type: Object
User profile data.
{firstName: <string>, lastName: <string>, dateOfBirth: <string>}
Returned value:
User profile information.
Type: Object.