Skip to main content

Update role

PUT 
/UpdateRole

Updates the details and permissions of an existing role in the graph database. The update is performed based on the provided data in the request body, specifying changes to the role.

Request​

Body

required

Add updated information for the particular role.

    data

    object

    required

    Updated information for the role.

    newRoleName string

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

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

    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

    read boolean

    Possible values: [true, false]

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

    create boolean

    Possible values: [true, false]

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

    update boolean

    Possible values: [true, false]

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

    delete boolean

    Possible values: [true, false]

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

    Warranty

    object

    Warranty app permissions

    read boolean

    Possible values: [true, false]

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

    create boolean

    Possible values: [true, false]

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

    update boolean

    Possible values: [true, false]

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

    delete boolean

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

    Assets

    object

    Assets app permissions

    read boolean

    Possible values: [true, false]

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

    create boolean

    Possible values: [true, false]

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

    update boolean

    Possible values: [true, false]

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

    delete boolean

    Possible values: [true, false]

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

    Video

    object

    Video app permissions

    read boolean

    Possible values: [true, false]

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

    create boolean

    Possible values: [true, false]

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

    update boolean

    Possible values: [true, false]

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

    delete boolean

    Possible values: [true, false]

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

    Manuals

    object

    Manuals app permissions

    read boolean

    Possible values: [true, false]

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

    create boolean

    Possible values: [true, false]

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

    update boolean

    Possible values: [true, false]

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

    delete boolean

    Possible values: [true, false]

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

    Alerts

    object

    Alerts app permissions

    read boolean

    Possible values: [true, false]

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

    create boolean

    Possible values: [true, false]

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

    update boolean

    Possible values: [true, false]

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

    delete boolean

    Possible values: [true, false]

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

    Devices

    object

    Devices app permissions

    read boolean

    Possible values: [true, false]

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

    create boolean

    Possible values: [true, false]

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

    update boolean

    Possible values: [true, false]

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

    delete boolean

    Possible values: [true, false]

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

    newRoleDescription string

    Possible values: [role updated for the new user]

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

    id stringrequired

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

    ID of the role to be updated.

Responses​

200 response

Schema

    roleId string

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

    ID of the updated role.

    roleName string

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

    Name of the updated role.

    roleDescription string

    Possible values: [role updated for the new user]

    Description of the updated role.

Loading...