Skip to main content

updateAccount

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

Parameters

Parameter	Description	Included in request	Type	Values
`accountId`	The ID of the target user account.	Mandatory	String	No additional requirements. Example "accountId" : "585d3d3faaed70970e8b45ed"
`email`	The email address for the account.	Optional	String	Must have a valid email format. Example "email": "[email protected]"
`authenticationMethod`	The method of authentication required for the user to log in.	Optional	Integer	Possible values: `0` - GravityZone Credentials `1` - Identity Provider `2` - GravityZone Identity Provider Example "email": "[email protected]"
`password`	The password for the account.	Optional	String	The password must 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. Example "password": "P@s4w0rd"
`profile`	An object containing profile information: `fullName`, `timezone` and `language`.	Optional	Object	For more information, refer to `profile`. Example "profile": { "fullName": "Bitdefender User", "language": "en_US", "timezone": "Europe/Bucharest" }
`phoneNumber`	An object containing phone number information	Optional	Object	For more information, refer to `phoneNumber`. Example "phoneNumber": { "countryCode": "+40", "subscriberNumber": "0000000000" }
`role`	The new role of the user.	Optional	Integer	These are the available roles: `1` - Company Administrator. `2` - Network Administrator. `3` - Reporter. `4` - Partner `5` - Custom. For this role, rights must be specified. Example "role": 5
`rights`	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.	Optional	Object	For more information, refer to `rights`. Example "rights": { "companyManager": true, "manageInventory": true, "managePoliciesRead": true, "managePoliciesWrite": true, "manageReports": true, "manageUsers": false }
`targetIds`	A list of IDs representing the targets to be managed by the user account.	Optional	Array	No additional requirements. Example "targetIds": [ "585d2dc9aaed70820e8b45b4", "585d2dd5aaed70b8048b45ca" ]

Objects

`profile`

Parameter	Description	Included in request	Type	Values
fullName	The first and last name of the user.	Mandatory	String	No additional requirements
language	The language displayed in Control Center.	Mandatory	String	No additional requirements
timezone	The timezone where the user works from.	Mandatory	String	No additional requirements

`phoneNumber`

Parameter	Description	Included in request	Type	Values
`countryCode`	The prefix of the country where the phone number is located.	Mandatory	Integer	Must be a valid country code prefix.
`subscriberNumber`	The phone number without the prefix.	Mandatory	Integer	Must be a valid phone number format.

`rights`

Parameter	Description	Included in request	Type	Values
`manageCompanies`	Allows users to create, delete, suspend, manage licensing and security for client companies.	Optional	Boolean	Default value: `false`.
`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.	Optional	Boolean	Default value: `false`.
`manageUsers`	Allows users to create, delete, or edit user accounts for their own company.	Optional	Boolean	Default value: `false`.
`manageReports`	Allows users to create, view, and edit reports for their own company.	Optional	Boolean	Default value: `false`.
`companyManager`	Provides users access to edit their company profile settings and make changes to licensing.	Optional	Boolean	Default value: `false`.
`manageRemoteShell`	Enables users to start Remote Shell sessions on managed target endpoints and perform advanced forensics. If set to `true`, the `manageNetworks` attribute is automatically set to true.	Optional	Boolean	Default value: `false`.
`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.	Optional	Boolean	Default value: `false`.
`managePoliciesRead`	Allows users to view company policies. Note Can not be included in the request if `manageNetworks` is present.	Optional	Boolean	Default value: `false`.
`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.	Optional	Boolean	Default value: `false`.

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]",
           "authenticationMethod" : 2,
           "profile": {
               "fullName":  "Bitdefender User",
               "language": "en_US",
               "timezone": "Europe/Bucharest"
           },
           "phoneNumber": {
               "countryCode": "+40",
               "subscriberNumber": "0000000000"
           },
           "password": "P@s4w0rd",
           "role": 5,
           "rights": {
               "companyManager": true,
               "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:

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.