Skip to main content

UpdateUserRequest

Request payload for updating a user

data objectrequired
newRoleNamestring

If you want to create a new role for the user and you have set the toggleButtonValue to create, then please provide the role permission in the form App Name and its corresponding create, read, update, delete permission.

Possible values: [``, NewUserRole]

lastNamestring

Last name of the user.

Possible values: [Curran]

newRoles object

If you want to create a new role for the user then please provide the role permission in the form of App Name and its corresponding create, read, update, delete permission.

Maps object

Maps app permissions

readboolean

Provide true to enable the read permission for the Maps app, else provide false.

Possible values: [true, false]

createboolean

Provide true to enable the create permission for the Maps app, else provide false.

Possible values: [true, false]

updateboolean

Provide true to enable the update permission for the Maps app, else provide false.

Possible values: [true, false]

deleteboolean

Provide true to enable the delete permission for the Maps app, else provide false.

Possible values: [true, false]

Warranty object

Warranty app permissions

readboolean

Provide true to enable the read permission for the Warranty app, else provide false.

Possible values: [true, false]

createboolean

Provide true to enable the create permission for the Warranty app, else provide false.

Possible values: [true, false]

updateboolean

Provide true to enable the update permission for the Warranty app, else provide false.

Possible values: [true, false]

deleteboolean

Provide true to enable the update permission for the Warranty app, else provide false.

Assets object

Assets app permissions

readboolean

Provide true to enable the read permission for the Assets app, else provide false.

Possible values: [true, false]

createboolean

Provide true to enable the create permission for the Assets app, else provide false.

Possible values: [true, false]

updateboolean

Provide true to enable the update permission for the Assets app, else provide false.

Possible values: [true, false]

deleteboolean

Provide true to enable the delete permission for the Assets app, else provide false.

Possible values: [true, false]

Video object

Video app permissions

readboolean

Provide true to enable the read permission for the Video app, else provide false.

Possible values: [true, false]

createboolean

Provide true to enable the create permission for the Video app, else provide false.

Possible values: [true, false]

updateboolean

Provide true to enable the update permission for the Video app, else provide false.

Possible values: [true, false]

deleteboolean

Provide true to enable the delete permission for the Video app, else provide false.

Possible values: [true, false]

Manuals object

Manuals app permissions

readboolean

Provide true to enable the read permission for the Manuals app, else provide false.

Possible values: [true, false]

createboolean

Provide true to enable the create permission for the Manuals app, else provide false.

Possible values: [true, false]

updateboolean

Provide true to enable the update permission for the Manuals app, else provide false.

Possible values: [true, false]

deleteboolean

Provide true to enable the delete permission for the Manuals app, else provide false.

Possible values: [true, false]

Alerts object

Alerts app permissions

readboolean

Provide true to enable the read permission for the Alerts app, else provide false.

Possible values: [true, false]

createboolean

Provide true to enable the create permission for the Alerts app, else provide false.

Possible values: [true, false]

updateboolean

Provide true to enable the update permission for the Alerts app, else provide false.

Possible values: [true, false]

deleteboolean

Provide true to enable the delete permission for the Alerts app, else provide false.

Possible values: [true, false]

Devices object

Devices app permissions

readboolean

Provide true to enable the read permission for the Devices app, else provide false.

Possible values: [true, false]

createboolean

Provide true to enable the create permission for the Devices app, else provide false.

Possible values: [true, false]

updateboolean

Provide true to enable the update permission for the Devices app, else provide false.

Possible values: [true, false]

deleteboolean

Provide true to enable the delete permission for the Devices app, else provide false.

Possible values: [true, false]

orgNamestring

Organization name for the user.

Possible values: [SUMA]

parentUserOldstring

Old parent user of the current user.

Possible values: [US-sadashiv.sangale@industrility.com]

discountClassesstring

Discount classes for the user.

Possible values: [{"ClassA":"18","ClassB":"10","ClassC":"0","DefaultClass":"25"}]

fileInfo object

File information for the user.

cdnUrlstring

url for the user logo, provide any https urls or upload a file to upload care and store the cdnUrl of it.

Possible values: [https://ucarecdn.com/6bac5b09-7daf-479a-b665-d107039b0eed/]

selectedSecurityGroupstring[]

Please add the id's of the selected security groups for the new user. You must have created the security group before creating user

userIdstring

User ID.

Possible values: [US-jesase9287@locawin.com]

firstNamestring

First name of the user.

Possible values: [Sam]

newRoleDescriptionstring

Description of the new role for the new user. Provide a description for the new role if you are creating the new user and have set the toggleButtonValue to create

Possible values: [``, role created for the new user]

toggleButtonValuestring

Toggle button value set to select if you are selecting the role from the existing available roles otherwise set it to the create to create new role

Possible values: [select, create]

isUnacceptedboolean

Flag indicating whether the user is unaccepted.

userTypestring

Type of the new user.

Possible values: [Customer, Manufacture, Distributor]

tempPasswordstring

Temporary password for the user.

selectedRolestring

If you do have the existing role in the account please enter the id of that role, if you looking to create new role you keep this field empty.

Possible values: [UR-customer, ``]

installedAppsData object

Installed apps data for the new user. Add App name as key and installation value either true or false for install or uninstall app respectively

Trainingboolean

set the value either true or false, true to install the app and false to uninstall

Possible values: [true, false]

Assetsboolean

set the value either true or false, true to install the app and false to uninstall

Possible values: [true, false]

Videoboolean

set the value either true or false, true to install the app and false to uninstall

Possible values: [true, false]

Manualsboolean

set the value either true or false, true to install the app and false to uninstall

Possible values: [true, false]

Maintenanceboolean

set the value either true or false, true to install the app and false to uninstall

Possible values: [true, false]

Homeboolean

set the value either true or false, true to install the app and false to uninstall

Possible values: [true, false]

Systemsboolean

set the value either true or false, true to install the app and false to uninstall

Possible values: [true, false]

emailstring

Email of the user.

Possible values: [jesase9287@locawin.com]

parentUserstring

Parent user of the current user.

Possible values: [US-sadashiv.sangale@industrility.com]

idstringrequired

ID of the user to be updated.

Possible values: [US-jesase9287@locawin.com]

previousData objectrequired
userNode objectrequired

Model representing user information

lastNamestring

User's last name

Possible values: [Sangale]

countrystring

User's country

Possible values: [India]

AccessVersionstring

Version of Access app

Possible values: [1.0]

preferredLanguagestring

User's preferred language

Possible values: [en_US, en_ja]

updateDatestring<date-time>

User's last update date

Possible values: [2023-12-20T11:18:41.285+00:00]

Supportstring

Support app purchase status information

Possible values: [installed, install]

citystring

User's city

Possible values: [Pune]

timezonestring

User's timezone

Possible values: [Asia/Kolkata]

VideoVersionstring

Version of Video app

Possible values: [1.0]

Accessstring

Access app purchase status information

Possible values: [purchased:installed, purchased:install]

typestring

User's type

Possible values: [Manufacturer]

preferredAppOnLoginVersionstring

Version of the preferred app on login

Possible values: [1.0]

preferredThemestring

User's preferred theme

Possible values: [default, darkTheme]

contactNumberstring

User's contact number

Possible values: [+919284155740]

logostring<uri>

URL of user's logo

Possible values: [https://ucarecdn.com/6bac5b09-7daf-479a-b665-d107039b0eed/]

idstring<email>

User ID

Possible values: [US-newuser@gmail.com]

statestring

User's state

Possible values: [Maharashtra]

Homestring

Home app purchase status information

Possible values: [purchased:installed, purchased:install]

createDatestring<date-time>

User's creation date

Possible values: [2023-02-17T16:39:56.946+00:00]

address2string

User's address line 2

Possible values: [Pimple Gurav]

discountClassesobject

User's discount classes

Possible values: [{"ClassA":"18","ClassB":"10","ClassC":"0","DefaultClass":"25"}]

address1string

User's address line 1

Possible values: [Bhagat Singh]

labelstring

User's label

Possible values: [user]

securityGroupstring[]

User's security groups

userNamestring

Username for login

Possible values: [newuser@gmail.com]

envstring

User's environment

Possible values: [dev]

zipcodestring

User's zip code

Possible values: [411061]

firstNamestring

User's first name

Possible values: [Sadashiv]

SupportVersionstring

Version of Support

Possible values: [1.0]

avatarImagestring

URL of user's avatar image

Possible values: [avatar-male.png, avatar-male1.png, avatar-male-2.png, avatar-male-3.png, avatar-male-4.png, avatar-female.png, avatar-female-2.png, avatar-female-3.png, ``]

preferredAppOnLoginstring

User's preferred app on login

Possible values: [Home]

Videostring

Video app purchase status information

Possible values: [purchased:installed, purchased:install]

namestring

User's full name

Possible values: [Sadashiv Sangale]

statusstring

User's status

Possible values: [active, inactive]

oldRolestringrequired

Old role of the user.

Possible values: [UR-administrator]

oldSecurityGroupstring[]

Old security groups for the user.

UpdateUserRequest
{
"data": {
"newRoleName": "",
"lastName": "Curran",
"newRoles": {
"Maps": {
"read": true,
"create": true,
"update": true,
"delete": true
},
"Warranty": {
"read": true,
"create": true,
"update": true,
"delete": true
},
"Assets": {
"read": true,
"create": true,
"update": true,
"delete": true
},
"Video": {
"read": true,
"create": true,
"update": true,
"delete": true
},
"Manuals": {
"read": true,
"create": true,
"update": true,
"delete": true
},
"Alerts": {
"read": true,
"create": true,
"update": true,
"delete": true
},
"Devices": {
"read": true,
"create": true,
"update": true,
"delete": true
}
},
"orgName": "SUMA",
"parentUserOld": "US-sadashiv.sangale@industrility.com",
"discountClasses": "{\"ClassA\":\"18\",\"ClassB\":\"10\",\"ClassC\":\"0\",\"DefaultClass\":\"25\"}",
"fileInfo": {
"cdnUrl": "https://ucarecdn.com/6bac5b09-7daf-479a-b665-d107039b0eed/"
},
"selectedSecurityGroup": [
"string"
],
"userId": "US-jesase9287@locawin.com",
"firstName": "Sam",
"newRoleDescription": "",
"toggleButtonValue": "select",
"isUnaccepted": true,
"userType": "Customer",
"tempPassword": "string",
"selectedRole": "UR-customer",
"installedAppsData": {
"Training": true,
"Assets": true,
"Video": true,
"Manuals": true,
"Maintenance": true,
"Home": true,
"Systems": true
},
"email": "jesase9287@locawin.com",
"parentUser": "US-sadashiv.sangale@industrility.com"
},
"id": "US-jesase9287@locawin.com",
"previousData": {
"userNode": {
"lastName": "Sangale",
"country": "India",
"AccessVersion": "1.0",
"preferredLanguage": "en_US",
"updateDate": "2023-12-20T11:18:41.285+00:00",
"Support": "installed",
"city": "Pune",
"timezone": "Asia/Kolkata",
"VideoVersion": "1.0",
"Access": "purchased:installed",
"type": "Manufacturer",
"preferredAppOnLoginVersion": "1.0",
"preferredTheme": "default",
"contactNumber": "+919284155740",
"logo": "https://ucarecdn.com/6bac5b09-7daf-479a-b665-d107039b0eed/",
"id": "US-newuser@gmail.com",
"state": "Maharashtra",
"Home": "purchased:installed",
"createDate": "2023-02-17T16:39:56.946+00:00",
"address2": "Pimple Gurav",
"discountClasses": {},
"address1": "Bhagat Singh",
"label": "user",
"securityGroup": [
"string"
],
"userName": "newuser@gmail.com",
"env": "dev",
"zipcode": "411061",
"firstName": "Sadashiv",
"SupportVersion": "1.0",
"avatarImage": "avatar-male.png",
"preferredAppOnLogin": "Home",
"Video": "purchased:installed",
"name": "Sadashiv Sangale",
"status": "active"
},
"oldRole": "UR-administrator",
"oldSecurityGroup": [
"string"
]
}
}