Skip to main content

Update user data

PUT 
/UpdateUser

Updates the information of a user, including roles, security groups, and installed apps in the graph database. The update is performed based on the provided data in the request body, specifying changes to the user.

Request​

Body

required

Add updated information for the particular user node.

    data

    object

    required

    newRoleName string

    Possible values: [``, NewUserRole]

    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.

    lastName string

    Possible values: [Curran]

    Last name of the user.

    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.

    orgName string

    Possible values: [SUMA]

    Organization name for the user.

    parentUserOld string

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

    Old parent user of the current user.

    discountClasses string

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

    Discount classes for the user.

    fileInfo

    object

    File information for the user.

    cdnUrl string

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

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

    selectedSecurityGroup string[]

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

    userId string

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

    User ID.

    firstName string

    Possible values: [Sam]

    First name of the user.

    newRoleDescription string

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

    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

    toggleButtonValue string

    Possible values: [select, create]

    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

    isUnaccepted boolean

    Flag indicating whether the user is unaccepted.

    userType string

    Possible values: [Customer, Manufacture, Distributor]

    Type of the new user.

    tempPassword string

    Temporary password for the user.

    selectedRole string

    Possible values: [UR-customer, ``]

    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.

    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

    Training boolean

    Possible values: [true, false]

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

    Assets boolean

    Possible values: [true, false]

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

    Video boolean

    Possible values: [true, false]

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

    Manuals boolean

    Possible values: [true, false]

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

    Maintenance boolean

    Possible values: [true, false]

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

    Home boolean

    Possible values: [true, false]

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

    Systems boolean

    Possible values: [true, false]

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

    email string

    Possible values: [jesase9287@locawin.com]

    Email of the user.

    parentUser string

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

    Parent user of the current user.

    id stringrequired

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

    ID of the user to be updated.

    previousData

    object

    required

    userNode

    object

    required

    Model representing user information

    lastName string

    Possible values: [Sangale]

    User's last name

    country string

    Possible values: [India]

    User's country

    AccessVersion string

    Possible values: [1.0]

    Version of Access app

    preferredLanguage string

    Possible values: [en_US, en_ja]

    User's preferred language

    updateDate date-time

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

    User's last update date

    Support string

    Possible values: [installed, install]

    Support app purchase status information

    city string

    Possible values: [Pune]

    User's city

    timezone string

    Possible values: [Asia/Kolkata]

    User's timezone

    VideoVersion string

    Possible values: [1.0]

    Version of Video app

    Access string

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

    Access app purchase status information

    type string

    Possible values: [Manufacturer]

    User's type

    preferredAppOnLoginVersion string

    Possible values: [1.0]

    Version of the preferred app on login

    preferredTheme string

    Possible values: [default, darkTheme]

    User's preferred theme

    contactNumber string

    Possible values: [+919284155740]

    User's contact number

    logo uri

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

    URL of user's logo

    id email

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

    User ID

    state string

    Possible values: [Maharashtra]

    User's state

    Home string

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

    Home app purchase status information

    createDate date-time

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

    User's creation date

    address2 string

    Possible values: [Pimple Gurav]

    User's address line 2

    discountClasses object

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

    User's discount classes

    address1 string

    Possible values: [Bhagat Singh]

    User's address line 1

    label string

    Possible values: [user]

    User's label

    securityGroup string[]

    User's security groups

    userName string

    Possible values: [newuser@gmail.com]

    Username for login

    env string

    Possible values: [dev]

    User's environment

    zipcode string

    Possible values: [411061]

    User's zip code

    firstName string

    Possible values: [Sadashiv]

    User's first name

    SupportVersion string

    Possible values: [1.0]

    Version of Support

    avatarImage string

    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, ``]

    URL of user's avatar image

    preferredAppOnLogin string

    Possible values: [Home]

    User's preferred app on login

    Video string

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

    Video app purchase status information

    name string

    Possible values: [Sadashiv Sangale]

    User's full name

    status string

    Possible values: [active, inactive]

    User's status

    oldRole stringrequired

    Possible values: [UR-administrator]

    Old role of the user.

    oldSecurityGroup string[]

    Old security groups for the user.

Responses​

200 response

Loading...