Skip to main content

CreateNewUserRequest

Request payload for creating a new user

newRoleNamestring

If you have set the toggleButtonValue to create, then please provide the unique role name.

Possible values: [``, NewUserRole]

lastNamestringrequired

Last name of the new user.

Possible values: [Kirstan]

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]

orgNamestringrequired

Organization name for the new user.

Possible values: [Prometha]

discountClassesstring

Discount classes for the new user. Generally we provide it in the stringified JSON object format if you don't want to provide any values for now you can keep it as empty value

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

fileInfo object

File information for the new 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[]required

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

userLoginTypestringrequired

Login type for the new user.

Possible values: [COGNITO, SSO]

firstNamestringrequired

First name of the new user.

Possible values: [Garry]

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]

userTypestringrequired

Type of the new user.

Possible values: [Customer, Manufacture, Distributor, SalesCompany]

selectedRolestringrequired

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 objectrequired

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]

emailstringrequired

Email of the new user.

Possible values: [oqadhdta@sharklasers.com]

parentUserstringrequired

Parent user userId for the new user.

Possible values: [US-rahul@industrility.com]

CreateNewUserRequest
{
"newRoleName": "",
"lastName": "Kirstan",
"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": "Prometha",
"discountClasses": "",
"fileInfo": {
"cdnUrl": "https://ucarecdn.com/6bac5b09-7daf-479a-b665-d107039b0eed/"
},
"selectedSecurityGroup": [
"string"
],
"userLoginType": "COGNITO",
"firstName": "Garry",
"newRoleDescription": "",
"toggleButtonValue": "select",
"userType": "Customer",
"selectedRole": "UR-customer",
"installedAppsData": {
"Training": true,
"Assets": true,
"Video": true,
"Manuals": true,
"Maintenance": true,
"Home": true,
"Systems": true
},
"email": "oqadhdta@sharklasers.com",
"parentUser": "US-rahul@industrility.com"
}