Methods
changePassword(currentPassword, newPassword) → {Promise.<boolean>}
Change the Password for the Current User Account [POST /user/change-password]
Parameters
-
currentPassword
stringThe Current Password
-
newPassword
stringThe New Password
Returns
-
Promise.<boolean>
Source
changePinCode(currentPinCode, newPinCode) → {Promise.<boolean>}
Change the Pin Code for the Current User Account [POST /user/change-pin-code]
Parameters
-
currentPinCode
stringThe Current Pin Code
-
newPinCode
stringThe New Pin Code
Returns
-
Promise.<boolean>
Source
create(createData) → {Promise.<UserAccountModel>}
Create a User Account [POST /users]
Parameters
-
createData
UserAccountController.CreateDataThe User Account Create Data
Returns
-
Promise.<UserAccountModel>
Source
delete(id) → {Promise.<boolean>}
Delete a User Account [DELETE /users/{id}]
Parameters
-
id
stringThe User Account ID
Returns
-
Promise.<boolean>
Source
deleteCurrent(currentPassword) → {Promise.<boolean>}
Delete the Current User Account [POST /user/delete-account]
Parameters
-
currentPassword
stringThe Current Password
Returns
-
Promise.<boolean>
Source
getAll(queryParametersopt) → {Promise.<Array.<UserAccountModel>>}
List all User Accounts [GET /users]
Parameters
-
queryParameters
UserAccountController.GetAllQueryParameters<optional>
The Optional Query Parameters
Returns
-
Promise.<Array.<UserAccountModel>>
Source
getCurrent() → {Promise.<UserAccountModel>}
Retrieve the Current User Account [GET /user]
Returns
-
Promise.<UserAccountModel>
Source
getOne(id) → {Promise.<UserAccountModel>}
Retrieve a User Account [GET /users/{id}]
Parameters
-
id
stringThe User Account ID
Returns
-
Promise.<UserAccountModel>
Source
getPolicies(id) → {Promise.<{policies: Array.<string>}>}
Retrieve the Policies Assigned to a User Account [GET /users/{id}/policies]
Parameters
-
id
stringThe User Account ID
Returns
-
Promise.<{policies: Array.<string>}>
Source
setPassword(newPassword) → {Promise.<boolean>}
Set the Password for the Current User Account [POST /user/set-password]
Parameters
-
newPassword
stringThe New Password
Returns
-
Promise.<boolean>
Source
setPinCode(newPinCode) → {Promise.<boolean>}
Set the Pin Code for the Current User Account [POST /user/set-pin-code]
Parameters
-
newPinCode
stringThe New Pin Code
Returns
-
Promise.<boolean>
Source
setPolicies(id, policies) → {Promise.<boolean>}
Set the Policies Assigned to a User Account [POST /users/{id}/policies]
Parameters
-
id
stringThe User Account ID
-
policies
Array.<string>An Array of Account Policy IDs
Returns
-
Promise.<boolean>
Source
update(id, updateData) → {Promise.<UserAccountModel>}
Update a User Account [PATCH /users/{id}]
Parameters
-
id
stringThe User Account ID
-
updateData
UserAccountController.UpdateDataThe User Account Update Data
Returns
-
Promise.<UserAccountModel>
Source
updateCurrent(updateData) → {Promise.<UserAccountModel>}
Update the Current User Account [PATCH /user]
Parameters
-
updateData
UserAccountController.UpdateDataThe User Account Update Data
Returns
-
Promise.<UserAccountModel>
Source
Type Definitions
CreateData
The Create Data for a User Account
Type
-
Object
Properties
-
email
stringThe User's Email Address
-
firstName
string<optional>
<nullable>
The User's First Name
-
lastName
string<optional>
<nullable>
The User's Last Name
-
companyId
stringThe Company this User belongs to
-
policies
Array.<string><optional>
The Policies that apply to this User Account
Source
GetAllQueryParameters
The Optional Query Parameters for the getAll Function
Type
-
Object
Properties
-
email
string<optional>
The User's Email Address
-
firstName
string<optional>
<nullable>
The User's First Name
-
lastName
string<optional>
<nullable>
The User's Last Name
-
companyId
string<optional>
The Company this User belongs to
Source
UpdateData
The Update Data for a User Account
Type
-
Object
Properties
-
email
string<optional>
The User's Email Address
-
firstName
string<optional>
<nullable>
The User's First Name
-
lastName
string<optional>
<nullable>
The User's Last Name