Skip to main content

UpdateRoleRequest

Request payload for updating a role

data objectrequired

Updated information for the role.

newRoleNamestring

Please provide the updated name for the role if you want to update the role name

Possible values: [new-user-role-update]

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]

newRoleDescriptionstring

Please provide the updated description for the role if you want to update the role name

Possible values: [role updated for the new user]

idstringrequired

ID of the role to be updated.

Possible values: [UR-e1c9873a-4b5c-4811-91b6-efb37b0ddd8f]

UpdateRoleRequest
{
"data": {
"newRoleName": "new-user-role-update",
"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
}
},
"newRoleDescription": "role updated for the new user"
},
"id": "UR-e1c9873a-4b5c-4811-91b6-efb37b0ddd8f"
}