createCompany
This method creates a customer or partner company account.
Parameters
Parameter | Type | Optional | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Number | No | The company type. Available values:
| ||||||||||
| String | No | The company name. Must be unique. | ||||||||||
| String | Yes | The ID of the parent partner company. | ||||||||||
| String | Yes | The company's physical address. | ||||||||||
| String | Yes | The company's country of operation. The value must be in ISO 3166 format. Default value: | ||||||||||
| String | Yes | The company's country state of operation. The value must be in ISO 3166 format. Default value: | ||||||||||
| String | Yes | The company's phone number. | ||||||||||
| String | Yes | The industry the company operates in. Possible values:
Default value: | ||||||||||
| Boolean | Yes | An option defining if the security of the new company can be managed by its Partner company. Available values: | ||||||||||
| Boolean | Yes | An parameter that defines Two Factor Authentication (2FA) enforcement for all GravityZone user accounts in the company. The value is always | ||||||||||
| Number | Yes | The period, defined in days, for which the users of the company can have their devices exempted from providing a two-factor code at authentication. Available values: | ||||||||||
| String | Yes | The email for the new user account to be linked to the new company. If the parameter | ||||||||||
| String | Yes | The full name of the new user account to be linked to the new company. This parameter is required when | ||||||||||
| Object | Yes | Contains information regarding the company's designated contact person. The object contains the following fields:
| ||||||||||
| String | Yes | The timezone of the new user account to be linked to the new company. The default value is | ||||||||||
| String | Yes | The user interface language for the new user account to be linked to the new company. The default value is | ||||||||||
| Object | Yes | An object containing the license details:
If not specified the company will be created with license subscription type | ||||||||||
| Object | Yes | An object containing the custom fields values for the company. |
Return value
This method returns a String: the ID of the newly-created company.
Example
Request:
{ "params": { "type": 0, "name": "Partner LTD", "parentId": "64babaafab366c53d20c83ca", "address": "Str Example No 1", "country": "US", "state": "US-CA", "phone": "0040740000000", "industry": 2, "canBeManagedByAbove": true, "enforce2FA": true, "skip2FAPeriod": 3, "accountEmail": "[email protected]", "accountFullName": "Partner account", "contactPerson": { "fullName": "Stephen Johnson", "email": "[email protected]", "phoneNumber": "0040740000001", "companyRole": "Owner / President" }, "licenseSubscription": { "type": 3, "reservedSlots": 120, "endSubscription": "2028-04-14", "autoRenewPeriod": 12, "manageExchange": false, "manageEncryption": false, "managePatchManagement": false, "manageIntegrityMonitoring": true, "imDataRetention": 2, "manageEmailSecurity": true, "manageMobileSecurity": true, "ownUse": { "manageXDRIdentityProviders": true, "manageXDRProductivityApps": true, "manageXDRNetwork": true, "manageXDRCloudWorkloads": true, "manageRemoteEnginesScanning": true, "manageContainerProtection": true, "manageHyperDetect": true, "manageSandboxAnalyzer": true, "manageEventCorrelator": true }, "resell": { "manageXDRResell": true, "manageRemoteEnginesScanningResell": true, "manageContainerProtectionResell": true, "manageHyperDetectResell": true, "manageSandboxAnalyzerResell": true, "manageEventCorrelatorResell": true }, "minimumUsage": { "endpointMonthlyUsage": 120 }, "assignedProductType": 0, "additionalProductTypes": [ 0 ], "assignedProtectionModel": "aLaCarte", "additionalProtectionModels": [ "aLaCarte", "mspSecure", "mspSecurePlus", "mspSecureExtra" ], "licensedServices": { "mdrServiceOwnUse": 1 } }, "customFields": { "referenceID": "004562", "vertical": "healthcare", "partner_type": "platinum", "security_level": "high", "payment_status": "goodstanding" } }, "jsonrpc": "2.0", "method": "createCompany", "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588" }
Response:
{ "id":"e249c22c-0ada-4772-a9f1-ee1cbb322588", "jsonrpc":"2.0", "result": "5493dcd2b1a43df00b7b23c6" }