Skip to main content

createAccount

You can use this method to create a user account and assign it a password.

Parameters

Parameter	Description	Included in request	Type	Values
`email`	The email address for the new account.	Mandatory	String	No additional requirements. Example "email": "[email protected]"
`profile`	An object containing profile information.	Mandatory	Object	Refer to `profile`. Example "profile": { "fullName": "Bitdefender User", "language": "en_US", "timezone": "Europe/Bucharest" },
`phoneNumber`	An object containing phone number information.	Optional	Object	Refer to `phoneNumber`. Example "phoneNumber": { "countryCode": "+40", "subscriberNumber": "0000000000" },
`password`	The password for the new account. If this value is omitted a password will be created and sent by email to the user	Optional	String	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. Example "password": "P@s4w0rd"
`companyId`	The company ID of the company you want to create the user under.	Optional	String	If not specified, the account will be linked to the company that holds the API key used to send the request. Example companyId": "58541613aaed7090058b4567
`role`	The role of the new account. For more information regarding user roles and the associated rights, refer to User roles	Optional	Number	Possible values: `1` - Company Administrator `2` - Network Administrator `3` - Reporter `4` - Partner `5` - Custom. If you assign this parameter the value `5`, you need to also include the `rights` parameter in the request. Default value: `1` Example "role": 5
`rights`	An object containing the rights of a user account. Only use this parameter if the `role` parameter is included in your request and is assigned the value `5`. In any other situation, the values assigned to the `rights` parameter are ignored.	Optional	Object	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`

Name	Description	Included in request	Type
`fullName`	The full name of the user.	Mandatory	String
`timezone`	The timezone the user.	Optional	String
`language`	the language displayed in the GravityZone console.	Optional	String

`phoneNumber`

Name	Description	Included in request	Type
`countryCode`	The prefix of the country where the phone number is located.	Mandatory	String
`subscriberNumber`	The phone number without the prefix.	Mandatory	String

`rights`

Name	Description	Included in request	Type
`manageCompanies`	Allows users to create, delete, suspend, manage licensing and security for client companies. Default value: `false`.	Optional	Boolean
`manageNetworks`	Important The `manageNetworks` attribute is deprecated. We recommend using the `manageInventory`, `managePoliciesRead`, and `managePoliciesWrite` attributes instead. Provides administrative privileges over these network security settings: Network inventory Policies Tasks Installation packages Quarantine If set to `true`, the `manageReports` right is automatically given the same value. 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. Default value: `false`.	Optional	Boolean
`manageUsers`	Allows users to create, delete, or edit user accounts for their own company. Default value: `false`.	Optional	Boolean
`manageReports`	Allows users to create, view, and edit reports for their own company. Default value: `false`.	Optional	Boolean
`companyManager`	Provides users access to edit their company profile settings and make changes to licensing. Default value: `false`.	Optional	Boolean
`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. Default value: `false`.	Optional	Boolean
`manageInventory`	Provides administrative privileges over network inventories, tasks, installation packages and quarantined items. Can not be included in the request if `manageNetworks` is present. Default value: `false`.	Optional	Boolean
`managePoliciesRead`	Allows users to view company policies. Can not be included in the request if `manageNetworks` is present. Default value: `false`.	Optional	Boolean
`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. Can not be included in the request if `manageNetworks` is present. Default value: `false`.	Optional	Boolean

Return value

Attribute	Type	Description
`result`	String	The ID of the created user account.

Example

Request

{
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
       "jsonrpc": "2.0",
       "method": "createAccount",
       "params": {
           "email": "[email protected]",
                      
           "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
           },
           "companyId": "58541613aaed7090058b4567",           
           "targetIds": [
               "585d2dc9aaed70820e8b45b4",
               "585d2dd5aaed70b8048b45ca"
           ]
       }
}

Response

  {
   "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
   "jsonrpc": "2.0",
   "result": "585d2dc9aaed70820abc45b4"
   }

In this section:

Was this helpful?

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