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.

phoneNumber

Object

Yes

An object containing phone number information:

  • countryCode - The prefix of the country where the phone number is located.

  • subscriberNumber - The phone number without the prefix.

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 - allows users to create, delete, suspend, manage licensing and security for client companies.

  • manageNetworks - provides administrative privileges over the network security settings:

    • Network inventory

    • Policies

    • Tasks

    • Installation packages

    • Quarantine

    Tip

    The manageNetworks attribute is deprecated. We recommend using the manageInventory, managePoliciesRead, and managePoliciesWrite attributes instead.

    If set to true, the manageReports right is automatically given the same value.

    Important

    If manageNetworks is present, its value will automatically be assigned to the manageInventory, managePoliciesRead, and managePoliciesWrite attributes. Trying to assign a different value to any of the three keys in the same request will result in an error.

  • manageUsers - allows users to create, delete, or edit user accounts for their own company.

  • manageReports - allows users to create, view, and edit reports for their own company.

  • companyManager - provides users access to edit their company profile settings and make changes to licensing.

  • manageInventory - provides administrative privileges over network inventories, tasks, installation packages and quarantined items.

    Note

    Can not be included in the request if manageNetworks is present.

  • managePoliciesRead - allows users to view company policies.

    Note

    Can not be included in the request if manageNetworks is present.

  • managePoliciesWrite - allows users to create and edit company policies.

    If the value is set to true, the value assigned to the managePoliciesRead parameter must also be set to true. Not including the managePoliciesRead attribute or assigning a different value to it will result in an error.

    Note

    Can not be included in the request if manageNetworks is present.

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"
           },
           "phoneNumber": {
               "countryCode": "+40",
               "subscriberNumber": "0000000000"
           },
           "password": "P@s4w0rd",
           "role": 5,
           "rights": {
               
               "manageInventory": true,
               "managePoliciesRead": true,
               "managePoliciesWrite": true,
               "manageReports": true,
               "manageUsers": false
           },
           "targetIds": [
               "585d2dc9aaed70820e8b45b4",
               "585d2dd5aaed70b8048b45ca"
           ]
       }
  }

Response

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