Skip to main content

updateAccount

This method updates a user account identified through the account ID.

Parameters

Parameter

Type

Optional

Description

accountId

String

No

The ID of the user account to be updated.

email

String

Yes

The email address for the account.

userName

String

Yes

The new usernamefor the user account.

password

String

Yes

The password for the account. The password should be at least twelve characters in length, and must contain at least one upper case character, one lower case character, one digit, one special character, and needs to be different from previously used passwords.

profile

Object

Yes

An object containing profile information: fullName, timezone and language.

role

Number

Yes

The new role of the user. These are the available roles:

  • 1 - Company Administrator.

  • 2 - Network Administrator.

  • 3 - Reporter.

  • 5 - Custom. For this role, rights must be specified.

rights

Object

Yes

An object containing the rights of a user account. This object should be set only when role parameter has the value 5 - Custom. When set for other roles, the values will be ignored and replaced with the rights specific to that role. The available rights are:

  • manageCompanies

  • manageNetworks Setting this to True implies manageReports right to true

  • manageUsers

  • manageReports

  • companyManager

Each option has two possible values: true, where the user is granted the right, or false otherwise. Omitted values from the request are automatically set to false.

targetIds

Array

Yes

A list of IDs representing the targets to be managed by the user account.

Return value

This method returns a Boolean which is True when the user account has been successfully updated.

Example

Request

 {
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
       "jsonrpc": "2.0",
       "method": "updateAccount",
       "params": {
           "accountId" : "585d3d3faaed70970e8b45ed",
           "email": "[email protected]",
           "profile": {
               "fullName":  "Bitdefender User",
               "language": "en_US",
               "timezone": "Europe/Bucharest"
           },
           "password": "P@s4w0rd",
           "role": 5,
           "rights": {
               "manageNetworks": true,
               "manageReports": true,
               "manageUsers": false
           },
           "companyId": "58541613aaed7090058b4567",
           "targetIds": [
               "585d2dc9aaed70820e8b45b4",
               "585d2dd5aaed70b8048b45ca"
           ]
       }
  }

Response

  {
   "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
   "jsonrpc": "2.0",
   "result": true
   }
In this section: