Skip to main content

createCompany

This method creates a Customer or Partner company account.

Parameters

Parameter

Type

Optional

Description and value requirements

type

Integer

No

The company type.

Available values:

  • 0 for Partner companies

  • 1 for Customer companies

name

String

No

The company name.

Must be unique. The company name must not exceed 64 characters.

parentId

String

Yes

The ID of the Partner company directly managing the newly created company.

address

String

Yes

The company's physical address.

The company address must not exceed 128 characters and must not contain HTML tags.

country

String

Yes

The company's country of operation.

The value must be in ISO 3166 format.

No value is set for this parameter by default.

state

String

Yes

The company’s state or primary administrative subdivision of operation.

The value must be in ISO 3166 format.

No value is set for this parameter by default.

phone

String

Yes

The company's phone number.

The phone number must not exceed 32 characters.

industry

Integer

Yes

The industry the company operates in. Possible values:

  • 0 - UNDEFINED

  • 1 - AEROSPACE

  • 101 - AEROSPACE_MANUFACTURING

  • 102 - AEROSPACE_TECHNOLOGY_RESEARCH

  • 2 - AGRICULTURE

  • 201 - AGRICULTURE_CHEMICALS_FERTILIZERS

  • 202 - AGRICULTURE_CROP_AND_ANIMAL_PRODUCTION

  • 203 - AGRICULTURE_FARM_MACHINERY

  • 204 - AGRICULTURE_FARMING

  • 205 - AGRICULTURE_FISHING

  • 206 - AGRICULTURE_FORESTRY

  • 207 - AGRICULTURE_HUNTING

  • 208 - AGRICULTURE_PRODUCTS

  • 3 - ARTS_ENTERTAINMENT

  • 301 - ARTS_ENTERTAINMENT_CULTURAL_ACTIVITIES

  • 302 - ARTS_ENTERTAINMENT_GAMBLING

  • 4 - AUTOMOTIVE

  • 401 - AUTOMOTIVE_AUTO_TRUCK_MOTORCYCLE_PARTS

  • 402 - AUTOMOTIVE_MACHINERY

  • 403 - AUTOMOTIVE_MANUFACTURERS

  • 404 - AUTOMOTIVE_MARKETING

  • 5 - BUSINESS_ASSOCIATIONS

  • 6 - CHEMICALS

  • 7 - COMMERCIAL_SERVICES

  • 701 - COMMERCIAL_SERVICES_VETERINARY

  • 8 - CONGLOMERATE

  • 9 - CONSTRUCTION

  • 901 - CONSTRUCTION_CIVIL_ENGINEERING

  • 902 - CONSTRUCTION_CONSTRUCTION_OF_BUILDINGS

  • 903 - CONSTRUCTION_CONTRACTORS

  • 904 - CONSTRUCTION_ENGINEERING

  • 905 - CONSTRUCTION_MATERIALS

  • 906 - CONSTRUCTION_SPECIALISED

  • 907 - CONSTRUCTION_UTILITY_SYSTEMS

  • 10 - CONSULTING

  • 11 - CONTAINERS_PACKAGING

  • 12 - DEFENSE

  • 1201 - DEFENSE_SHIPBUILDING_AIRCRAFT

  • 1202 - DEFENSE_SPACE

  • 1203 - DEFENSE_WEAPONS

  • 13 - EDUCATION_RESEARCH

  • 1301 - EDUCATION_RESEARCH_SCIENTIFIC_RESEARCH_AND_DEVELOPMENT

  • 14 - ENERGY

  • 1401 - ENERGY_EQUIPMENT_TECHNOLOGIES

  • 1402 - ENERGY_INFRASTRUCTURE

  • 1403 - ENERGY_OIL_GAS_CONSUMABLE_FUELS

  • 1404 - ENERGY_RENEWABLE_ENERGY

  • 15 - ENGINEERING

  • 16 - FINANCIAL_SERVICES

  • 1601 - FINANCIAL_SERVICES_BANKS

  • 1602 - FINANCIAL_SERVICES_DIVERSIFIED

  • 1603 - FINANCIAL_SERVICES_INSURANCE

  • 1604 - FINANCIAL_SERVICES_INVESTMENT

  • 1605 - FINANCIAL_SERVICES_REAL_ESTATE

  • 17 - FOOD_BEVERAGES

  • 18 - GOVERNMENT

  • 1801 - GOVERNMENT_LOCAL

  • 1802 - GOVERNMENT_NATIONAL

  • 1803 - GOVERNMENT_PRIVATE_CONTRACTORS

  • 1804 - GOVERNMENT_PUBLIC_ADMINISTRATION_AND_DEFENSE

  • 1805 - GOVERNMENT_PUBLIC_SERVICES

  • 1806 - GOVERNMENT_REGIONAL

  • 19 - HEALTHCARE

  • 1901 - HEALTHCARE_EQUIPMENT_SERVICES

  • 1902 - HEALTHCARE_PHARMACEUTICALS_BIOTECHNOLOGY_LIFE_SCIENCES

  • 1903 - HEALTHCARE_RESEARCH

  • 20 - HOSPITALITY_LEISURE

  • 2001 - HOSPITALITY_LEISURE_HOTEL_MOTELS_CRUISE_LINES

  • 2002 - HOSPITALITY_LEISURE_LEISURE_RECREATION

  • 2003 - HOSPITALITY_LEISURE_RESTAURANT_BARS

  • 21 - MANUFACTURING

  • 2101 - MANUFACTURING_BASIC_METALS

  • 2102 - MANUFACTURING_BEVERAGES

  • 2103 - MANUFACTURING_CHEMICALS_PRODUCTS

  • 2104 - MANUFACTURING_ELECTRICAL_EQUIPMENT

  • 2105 - MANUFACTURING_ELECTRONICS

  • 2106 - MANUFACTURING_FABRICATED_METAL_PRODUCTS

  • 2107 - MANUFACTURING_FOOD_PRODUCTS

  • 2108 - MANUFACTURING_FURNITURE

  • 2109 - MANUFACTURING_MACHINERY_EQUIPMENT

  • 2110 - MANUFACTURING_MOTOR_VEHICLES

  • 2111 - MANUFACTURING_NON_METALLIC_MINERAL_PRODUCTS

  • 2112 - MANUFACTURING_PAPER_PRODUCTS

  • 2113 - MANUFACTURING_PETROLEUM_PRODUCTS

  • 2114 - MANUFACTURING_PHARMACEUTICAL_PRODUCTS

  • 2115 - MANUFACTURING_TEXTILES

  • 2116 - MANUFACTURING_TOBACCO

  • 2117 - MANUFACTURING_TRANSPORT

  • 2118 - MANUFACTURING_WEARING_APPAREL

  • 2119 - MANUFACTURING_WOOD

  • 22 - MARINE

  • 23 - MEDIA

  • 2301 - MEDIA_ADVERTISING_MARKETING

  • 2302 - MEDIA_BROADCASTING

  • 2303 - MEDIA_ENTERTAINMENT

  • 2304 - MEDIA_PUBLISHING

  • 24 - MINING

  • 2401 - MINING_COAL_AND_LIGNITE

  • 2402 - MINING_METAL_ORES

  • 2403 - MINING_PETROLEUM_AND_NATURAL_GAS

  • 2404 - MINING_PRECIOUS_METALS

  • 2405 - MINING_QUARRYING

  • 2406 - MINING_SERVICES

  • 25 - NON_PROFIT

  • 26 - OFFICES_OF_LAWYERS

  • 27 - PAPER_FOREST_PRODUCTS

  • 28 - RETAIL

  • 2801 - RETAIL_BEVERAGES

  • 2802 - RETAIL_BOOKS_AND_NEWS

  • 2803 - RETAIL_BUILDING_MATERIALS

  • 2804 - RETAIL_CLOTHING_STORES

  • 2805 - RETAIL_DISTRIBUTORS

  • 2806 - RETAIL_ELECTRONIC_SHOPPING

  • 2807 - RETAIL_ELECTRONICS

  • 2808 - RETAIL_GASOLINE_STATIONS

  • 2809 - RETAIL_HOME_FURNISHING

  • 2810 - RETAIL_LUXURY_STORES

  • 2811 - RETAIL_MULTILINE_RETAIL

  • 2812 - RETAIL_PERSONAL_CARE_STORES

  • 2813 - RETAIL_SPECIALTY_FOOD_STORES

  • 2814 - RETAIL_SUPERMARKETS

  • 2815 - RETAIL_SUPPLIES_STORES

  • 2816 - RETAIL_VEHICLES

  • 29 - SUPPORT_SERVICE_ACTIVITIES

  • 2901 - SUPPORT_SERVICE_ACTIVITIES_BUSINESS_SUPPORT

  • 2902 - SUPPORT_SERVICE_ACTIVITIES_EMPLOYMENT

  • 2903 - SUPPORT_SERVICE_ACTIVITIES_MAINTENANCE_SERVICES

  • 2904 - SUPPORT_SERVICE_ACTIVITIES_RENTAL_AND_LEASING

  • 2905 - SUPPORT_SERVICE_ACTIVITIES_SECURITY_AND_INVESTIGATION

  • 2906 - SUPPORT_SERVICE_ACTIVITIES_SOCIAL_ASSISTANCE

  • 2907 - SUPPORT_SERVICE_ACTIVITIES_TRAVEL_AGENCY

  • 30 - TECHNOLOGY

  • 3001 - TECHNOLOGY_ARTIFICIAL_INTELLIGENCE

  • 3002 - TECHNOLOGY_ELECTRONIC_EQUIPMENT_COMPONENTS

  • 3003 - TECHNOLOGY_HARDWARE

  • 3004 - TECHNOLOGY_IT_SERVICES

  • 3005 - TECHNOLOGY_SECURITY

  • 3006 - TECHNOLOGY_SEMICONDUCTORS_SEMICONDUCTOR_EQUIPMENT

  • 3007 - TECHNOLOGY_SOFTWARE

  • 31 - TELECOMMUNICATIONS_SERVICES

  • 3101 - TELECOMMUNICATIONS_SERVICES_COMMUNICATIONS_INFRASTRUCTURE

  • 3102 - TELECOMMUNICATIONS_SERVICES_INTEGRATED_TELECOMMUNICATIONS

  • 3103 - TELECOMMUNICATIONS_SERVICES_WIRELESS_TELECOMMUNICATIONS

  • 32 - TRANSPORTATION

  • 3201 - TRANSPORTATION_AIR_TRANSPORTATION

  • 3202 - TRANSPORTATION_DEEP_SEA_COASTAL_AND_GREAT_LAKES_WATER_TRANSPORTATION

  • 3203 - TRANSPORTATION_GENERAL_FREIGHT_TRUCKING

  • 3204 - TRANSPORTATION_INFRASTRUCTURE

  • 3205 - TRANSPORTATION_INLAND_WATER_TRANSPORTATION

  • 3206 - TRANSPORTATION_PIPELINE_TRANSPORTATION

  • 3207 - TRANSPORTATION_POSTAL_AND_COURIER

  • 3208 - TRANSPORTATION_RAIL_TRANSPORTATION

  • 3209 - TRANSPORTATION_ROAD_TRANSPORTATION

  • 3210 - TRANSPORTATION_SIGHTSEEING

  • 3211 - TRANSPORTATION_URBAN_TRANSIT_SYSTEMS

  • 3212 - TRANSPORTATION_WATER_TRANSPORTATION

  • 33 - UTILITIES

  • 3301 - UTILITIES_ELECTRICITY_GAS

  • 3302 - UTILITIES_WATER_SUPPLY

  • 34 - WHOLESALE

  • 3401 - WHOLESALE_APPAREL

  • 3402 - WHOLESALE_BEVERAGES

  • 3403 - WHOLESALE_BUILDING_MATERIALS

  • 3404 - WHOLESALE_CHEMICALS

  • 3405 - WHOLESALE_DRUGS

  • 3406 - WHOLESALE_ELECTRONIC_MARKETS

  • 3407 - WHOLESALE_ELECTRONICS

  • 3408 - WHOLESALE_FARM_PRODUCTS

  • 3409 - WHOLESALE_GROCERY

  • 3410 - WHOLESALE_HOME_FURNISHING

  • 3411 - WHOLESALE_METAL_AND_MINERAL

  • 3412 - WHOLESALE_NONDURABLE_GOODS

  • 3413 - WHOLESALE_PETROLEUM

  • 3414 - WHOLESALE_SUPPLIES

  • 3415 - WHOLESALE_VEHICLES

Default value: 0.

canBeManagedByAbove

Boolean

Yes

An option defining whether the security of the new company can be managed by its Partner company.

Available values: true or false.

The default value is true.

Important

For companies using MDR, this parameter must have the true value.

enforce2FA

Boolean

Yes

A parameter that defines Two Factor Authentication (2FA) enforcement for all GravityZone user accounts in the company.

The value is always true.

skip2FAPeriod

Integer

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:

  • 0

  • 1

  • 3

  • 7

  • 14

  • 30

  • 90

accountEmail

String

Yes

The email for the new user account to be linked to the new company.

If the parameter canBeManagedByAbove is set to false, this parameter is mandatory.

accountFullName

String

Yes

The full name of the new user account to be linked to the new company.

This parameter is required when canBeManagedByAbove is set to false.

contactPerson

Object

Yes

Contains information regarding the company's designated contact person. The object contains the following fields:

  • fullName - the person's first and last name.

  • email - their business email address.

    Important

    This field is mandatory when the contactPerson parameter is included in the request.

  • phoneNumber, their business phone number.

  • companyRole, their position in the company.

accountTimezone

String

Yes

The timezone of the new user account to be linked to the new company.

The default value is Europe/Bucharest.

accountLanguage

String

Yes

The user interface language for the new user account to be linked to the new company.

The default value is en_US.

licenseSubscription

Object

Yes

An object containing the license details:

  • type, an integer representing the license or subscription type.

    Possible values:

    • 1 (trial)

    • 2 (license)

    • 3 (monthly subscription)

    • 4 (monthly license trial)

    • 5 (monthly subscription trial)

    • 6 (FRAT subscription)

  • licenseKey, a string representing a valid license key.

    Important

    This parameter is mandatory for the license or subscription type 2 (license).

  • reservedSlots, an integer representing the number of seats ensured for the target company.

    Valid values are between 1 and the number of free seats of the Partner company managing directly the company being created.

    Important

    This parameter should be set when the license or subscription type is 3 or 5. If not specified, all license seats will be taken from the licenses pool shared with other companies.

  • endSubscription, a String representing the UTC end date for the product subscription.

    Important

    • This parameter can be set when the license or subscription type is 3 (monthly subscription).

    • To unset endSubscription, use an empty string: " ".

  • autoRenewPeriod, an Integer representing license validity in months, after auto-renewal.

    Important

    • This parameter can be set when the license subscription type is 3 (monthly subscription).

    • The default value is 12, provided endSubscription is set.

    • For no auto-renewal, use 0.

  • manageExchange, a boolean specifying whether the company can use Security for Exchange or not.

    Important

    • The default value is false.

    • This parameter can be used only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    • If omitted, Security for Exchange will be unavailable.

  • minimumUsage, an Object containing types of licenses and the minimum number of slots which the company commits through legal agreement to use on a monthly basis.

    • endpointMonthlyUsage, the minimum number of endpoints that the client agreed to use from the main license.

    Important

    This parameter can only be set when the license or subscription type is 3 (monthly subscription).

  • assignedProductType, an integer representing the type of the product that the company will use.

    Possible values:

    • 0 (Endpoint Security)

    • 3 (Bitdefender EDR)

    • 5 (Bitdefender PHASR)

    The default value is 0.

    Important

    You can use this parameter only with the following types of licensing: 3 for monthly subscription, 5 for monthly subscription trial.

  • additionalProductTypes, an array of integers representing types of products. This parameter allows the Partner company being created to assign various products to their clients.

    Possible values of the array elements:

    • 0 (Endpoint Security)

    • 3 (Bitdefender EDR)

    • 5 (Bitdefender PHASR)

    Important

    • If set, it must contain at least the value of assignedProductType.

    • The default value is an array containing the value of assignedProductType.

    • You can use this parameter only with the following types of licensing: 3 (monthly subscription), 5 (monthly subscription trial).

  • assignedProtectionModel, a string representing the type of the protection model that the company will use.

    Possible values:

    • aLaCarte

    • mspSecure

    • mspSecurePlus

    • mspSecureExtra

    Default value: depends on the protection models made available by the Partner company.

    You can only use this parameter if all the following conditions are met:

    • type is 3 (monthly subscription)

    • assignedProductType is 0 (Endpoint Security)

    Note

    The value assigned to this parameter will automatically assign one or more values to the additionalProtectionModels array.

    assignedProtectionModel

    Default values for additionalProtectionModels

    aLaCarte

    aLaCarte

    mspSecure

    mspSecure

    mspSecurePlus

    mspSecure, mspSecurePlus

    mspSecureExtra

    mspSecure, mspSecurePlus, mspSecureExtra

  • additionalProtectionModels, an array of strings representing types of protection models. This parameter allows the Partner company being created to assign additional protection models to their clients apart from the ones provided by the assignedProtectionModel object.

    Possible values:

    • aLaCarte

    • mspSecure

    • mspSecurePlus

    • mspSecureExtra

    Default value: depends on the value assigned to the assignedProtectionModel field.

    Use the additionalProtectionModels parameter only with a monthly subscription (type 3) and when Endpoint Security (0) is included as assignedProductType or in additionalProductType.

  • manageIntegrityMonitoring - a boolean specifying whether the company can use Integrity Monitoring service or not.

    Important

    • The default value is false.

    • This parameter can be used only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    • If omitted, the service will be unavailable.

  • manageComplianceManager - a boolean specifying whether the company can use Compliance Manager service or not.

    Important

    • The default value is false.

    • This parameter can be used only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    • This parameter is available when assignedProductType is set to 0 (Endpoint Security) or 5 (Bitdefender PHASR).

    • If omitted, the service will be unavailable.

  • manageHyperDetect - a boolean specifying whether the company can use the HyperDetect service or not.

    Important

    • The default value is false.

    • This parameter can be used only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    • If omitted, the service will be unavailable.

  • manageEASM, a boolean specifying whether the company can use EASM or not.

    Important

    • The default value is false.

    • This parameter can be used only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    • If omitted, the service will be unavailable.

  • imDataRetention - an integer specifying the number of days the events will be stored for.

    This option is only returned if manageIntegrityMonitoring is set to true.

    Possible values:

    • 0 (7 days retention)

    • 1 (90 days retention)

    • 2 (180 days retention)

    • 3 (365 days retention)

    The default value is 0 (7 days retention).

    Companies with license type set to 5 (monthly subscription trial) can only have this option set to 0 (7 days retention).

  • edrDataRetention, an integer indicating if the EDR Data Retention feature is enabled for the company, and how long data is stored. Possible values:

    • 0 - Data retention is not enabled.

    • 1 - Data retention is enabled for 90 days.

    • 2 - Data retention is enabled for 180 days.

    • 3 - Data retention is enabled for 1 year.

    To use this parameter, the manageEventCorrelator parameter must also be included in the request and set to true if the assignedProtectionModel is set to aLaCarte.

  • ownUse, an object containing activation settings for the company's services and add-ons. This setting is only compatible with companies that have a license of type 3 or 5 (monthly inherited subscription).

    • manageXDRIdentityProviders, gives access to Sensors Management integration for Azure AD and Active Directory. Available values: true or false.

    • manageXDRProductivityApps, gives access to Sensors Management integration for Office 365. Available values: true or false.

    • manageXDRNetwork, gives access to Sensors Management integration for Network Sensor. Available values: true or false.

    • manageXDRCloudWorkloads, gives access to Sensors Management integration for AWS. Available values: true or false.

      Important

      To assign the true value to any of the parameters above, the manageEventCorrelator parameter or the manageEventCorrelator attribute under the ownuse parameter needs to be set to true.

      Note

      Assigning true to any of the manageXDRIdentityProviders, manageXDRProductivityApps, manageXDRNetwork or manageXDRCloudWorkloads settings will activate XDR. To deactivate XDR, set all of them to false.

    • manageRemoteEnginesScanning, optional, activates the Security for Virtualized Environments service for your company.

      Possible values: true or false.

      Default value: false.

      Important

      This setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned.

      Note

      This setting can not be used if the manageRemoteEnginesScanning parameter outside the ownUse object is present.

    • manageContainerProtection, optional, activates the Container Protection service for your company. Possible values: true or false.

      Important

      This setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned.

      Note

      This setting can not be used if the manageContainerProtection parameter outside of the ownUse object is present.

    • manageEventCorrelator, a boolean specifying whether the company can use Endpoint Detection and Response or not.

      The default value is false.

      Setting this parameter to true will automatically set the manageSandboxAnalyzer and manageHyperDetect settings under the ownuse parameter to true.

      Note

      This setting can not be used if the manageEventCorrelator parameter outside of the ownUse object is present.

    • manageSandboxAnalyzer, a boolean specifying whether the company can use Sandbox Analyzer or not.

      The default value is false.

      Note

      This setting can not be used if the manageSandboxAnalyzer parameter outside of the ownUse object is present.

    • manageHyperDetect, a boolean specifying whether the company can use HyperDetect or not.

      The default value is false.

      Note

      This setting can not be used if the manageHyperDetect parameter outside of the ownUse object is present.

    • managePHASR, a boolean specifying whether the company can use PHASR or not.

      The default is false.

      Note

      • This setting can not be used if the managePHASR parameter outside of the ownUse object is present.

      • This setting can only be set to true if assignedProtectionModel has the mspSecure, mspSecurePlus, or mspSecureExtra value.

    • manageEASM, a boolean specifying whether the company can use EASM or not.

      The default is false.

      Note

      • This setting can only be set to true if assignedProtectionModel has the mspSecure, mspSecurePlus, or mspSecureExtra value.

      • This setting can not be used if the manageEASM parameter outside of the ownUse object is present.

    • manageComplianceManager, a boolean specifying whether the company can use the Compliance Manager add-on or not.

      The default value is false.

      This parameter is available for own use when assignedProductType is set to 0 (Endpoint Security) or 5 (Bitdefender PHASR).

      Note

      This setting can not be used if the manageComplianceManager parameter outside of the ownUse object is present.

    • manageExtendedEmailSecurity, a boolean specifying whether the company can use the Extended Email Security add-on or not.

      The default value is false.

      Note

      This setting can not be used if the manageExtendedEmailSecurity parameter outside of the ownUse object is present.

    • managePatchManagement, a boolean specifying whether the company can use the Patch Management add-on or not.

      The default value is false.

      This parameter is available for own use when assignedProductType is set to 0 (Endpoint Security) or 5 (Bitdefender PHASR).

      Note

      This setting can not be used if the managePatchManagement parameter outside of the ownUse object is present.

  • resell, an object containing your company's reselling settings for services and add-ons. This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    • manageXDRResell - allows selling the XDR service to your customers.

      Available values: true or false.

      Note

      If true, the manageXDRIdentityProviders, manageXDRProductivityApps, manageXDRNetwork and manageXDRCloudWorkloads will automatically be set as true for your managed companies.

    • manageRemoteEnginesScanningResell, optional, allows selling the Security for Virtualized Environments service to your customers.

      Possible values: true or false.

      Default value: false.

      Important

      This setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned.

      Note

      This setting can not be used if the manageRemoteEnginesScanning parameter outside of the resell object is present.

    • manageContainerProtectionResell, optional, allows selling the Container Protection service to your customers.

      Possible values: true or false.

      Default value: false.

      Important

      This setting can only be set to true if the additionalProtectionModels parameter has the aLaCarte value assigned.

      Note

      This setting can not be used if the manageContainerProtection parameter outside of the ownUse object is present.

    • manageEventCorrelatorResell, optional, allows selling EDR to your customers.

      Possible values: true or false.

      Default value: false.

      Setting this setting to true will automatically set the manageSandboxAnalyzerResell and manageHyperDetectResell settings under the resell parameter to true.

      Note

      This setting can not be used if the manageEventCorrelator parameter outside of the ownUse object is present.

    • manageSandboxAnalyzerResell, optional, allows selling Sandbox Analyzer to your customers.

      Possible values: true or false.

      Default value: false.

      Note

      This setting can not be used if the manageS parameter outside of the ownUse object is present.

    • manageHyperDetectResell, optional, allows selling HyperDetect to your customers.

      The default value is false.

      Note

      This setting can not be used if the manageHyperDetect parameter outside of the ownUse object is present.

    • managePHASRResell, allows selling PHASR to your customers.

      The default is false.

      Note

      This setting can not be used if the managePHASR parameter outside of the ownUse object is present.

    • manageEASMResell, allows selling EASM to your customers.

      The default is false.

      Note

      This setting can not be used if the manageEASM parameter outside of the ownUse object is present.

    • manageComplianceManagerResell, optional, allows selling the Compliance Manager add-on to your customer.

      Possible values: true or false.

      Default value: false.

      This parameter is available for resell when additionalProductTypes includes 0 (Endpoint Security) or 5 (Bitdefender PHASR).

      Note

      This setting can not be used if the manageComplianceManager parameter outside of the ownUse object is present.

    • manageExtendedEmailSecurityResell, optional, allows selling the Extended Email SEcurity add-on to your customer.

      Possible values: true or false.

      Default value: false.

      Note

      This setting can not be used if the manageExtendedEmailSecurity parameter outside of the ownUse object is present.

    • managePatchManagementResell, optional, allows selling the Patch Management add-on to your customer.

      Possible values: true or false.

      Default value: false.

      This parameter is available for resell when additionalProductTypes includes 0 (Endpoint Security) or 5 (Bitdefender PHASR).

      Note

      This setting can not be used if the managePatchManagement parameter outside of the ownUse object is present.

  • manageEncryption, a boolean specifying whether the company can use Full Disk Encryption or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

  • manageRemoteEnginesScanning, a boolean specifying whether the company can use Security for Virtualized Environments or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

    Important

    This setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned.

    Note

    This parameter can not be used if any of the manageRemoteEnginesScanning and manageRemoteEnginesScanningResell settings under the ownUse and resell object exist.

  • manageHyperDetect, a boolean specifying whether the company can use HyperDetect or not.

    The default value is false.

    This parameter makes sense only when creating a company with a license or subscription of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

    Note

    This parameter can not be used if any of the manageHyperDetect and manageHyperDetectResell settings under the ownUse and resell object parameters exist.

  • manageSandboxAnalyzer, a boolean specifying whether the company can use Sandbox Analyzer or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

    Note

    This parameter can not be used if any of the manageSandboxAnalyzer and manageSandboxAnalyzerResell settings under the ownUse and resell object parameters exist.

  • managePatchManagement, a boolean specifying whether the company can use Patch Management or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

    This parameter is available for own use when assignedProductType is set to 0 (Endpoint Security) or 5 (Bitdefender PHASR).

    Note

    This parameter can not be used if any of the managePatchManagement and managePatchManagementResell settings under the ownUse and resell object parameters exist.

  • manageEventCorrelator, a boolean specifying whether the company can use EDR or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    EDR requires Sandbox Analyzer and HyperDetect to be enabled. Thus, setting this parameter to true will automatically set to true these two parameters: manageSandboxAnalyzer and manageHyperDetect.

    If the parameter is omitted, the service will not be available.

    Note

    This parameter can not be used if any of the manageEventCorrelator and manageEventCorrelatorResell settings under the ownUse and resell object parameters exist.

  • manageMobileSecurity, a boolean specifying whether the company can use Mobile Security service or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

  • manageExtendedEmailSecurity, a boolean specifying whether the company can use Extended Email Security service or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

  • manageContainerProtection, a boolean specifying whether the company can use the Container Protection service or not.

    The default value is false.

    This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription).

    If omitted, the service will be unavailable.

    The value cannot be true if assignedProtectionModel is set to mspSecure, mspSecurePlus or mspSecureExtra.

    Important

    • This setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned.

    • This parameter can not be used if any of the manageContainerProtection and manageContainerProtectionResell settings under the ownUse and resell object parameters exist.

  • licensedServices, an object containing service settings for the company:

    • mdrServiceOwnUse, an integer indicating whether the MDR service is enabled for the company's own use.

      Possible values:

      • 0 (Managed Detection and Response Foundations is disabled)

      • 1 (Managed Detection and Response Foundations is enabled)

      Important

      • Enabling this option will also enable EDR.

      • This parameter can only be set to 1 if the type parameter is set to 1 (the company type is set to Customer).

      • If omitted, MDR will be unavailable for own use.

    • mdrServiceResell, a boolean specifying whether the company is allowed to resell MDR services to the companies it creates.

      Important

      • This parameter is only valid for Partner companies (with type 0).

      • If omitted, MDR will be unavailable for resell.

    Important

    This parameter can be used only when creating a company with license or subscription of type 3.

If not specified, the company will be created with license or subscription of type 1, trial.

mdrContactInformation

Object

No, for Customer companies with a yearly MDR license

Not applicable to other types of companies

Note

This information must be valid.

The company's designated emergency contact details, intended for use by the MDR team during security events or incidents.

Might contain the following details:

  • phoneNumber, an object containing the company's contact details needed to reach the organization by phone. It contains the following information:

    • countryPrefix, a string containing the prefix for the country where the company is located.

      Note

      • For countries that do not have a unique prefix, include the countryCode parameter as well.

      • The following prefixes are shared by multiple countries: +1, +599, +39, +7, +44.

    • countryCode, a string representing the ISO 3166-1 alpha-2 code of the country where the company is located.

      Note

      This parameter should only be used to identify the country when the company resides in a region that shares a telephone prefix with other countries.

    • subscriberNumber, a string representing the local portion of the company’s telephone number, excluding any country prefix or national dialing code.

      The subscriber number must contain between 3 and 15 digits (numbers only).

  • fullName, a string containing the full name of the designated emergency contact person from the company.

  • email, a string containing the email address of the designated emergency contact person from the company.

    Note

    If the specified email address has not been previously verified, emailVerificationCode must also be included in the request.

  • emailVerificationCode, a string or numeric code used to verify ownership of the specified email address.

    Note

    You can get this code by using the generateEmailVerificationCode method.

  • useDataFromAccount - a string representing the ID of the GravityZone user account from which to import all relevant contact information, including the full name, email, and phone number.

    Important

    • If the specified user account has not been previously verified, emailVerificationCode must also be included in the request.

    • The user account must be accessible to you, meaning it belongs to any company that you manage.

  • useDataFromCompany - a string representing the ID of a GravityZone company account from which to import all relevant contact information, including the full name, email, and phone number.

    Important

    The company account must belong to a company you manage.

Important

The MDR contact information can be configured using one of the following methods:

  • Provide only phoneNumber, fullName, and email, with emailVerificationCode when necessary.

  • Provide only useDataFromAccount, with emailVerificationCode when necessary.

  • Provide useDataFromCompany only.

These methods are mutually exclusive and cannot be combined within the same request.

customFields

Object

Yes

An object containing the custom field values for the company.

duplicateClosedIncidentsOnUpdate

Boolean

Yes

When set to:

  • true: Updates found on a closed incident trigger the creation of a new incident.

  • false: If updates are detected on a closed incident, the incident is reopened.

Default value: false.

Important

This parameter cannot be set to true for Customers with an active MDR license or subscription.

Return value

This method returns a String: the ID of the newly-created company.

Example

Request:

A Partner company using a monthly subscription license, with an Endpoint Security product type, and an A la carte protection model:

{
    "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": "partner@example.com",
        "accountFullName": "Partner account",
        "contactPerson": {
            "fullName": "Stephen Johnson",
            "email": "stephen.johnson@example.email.com",
            "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,
            "edrDataRetention": 2,
            "ownUse": {
                "manageXDRIdentityProviders": true,
                "manageXDRProductivityApps": true,
                "manageXDRNetwork": true,
                "manageXDRCloudWorkloads": true,
                "manageRemoteEnginesScanning": true,
                "manageContainerProtection": true,
                "manageHyperDetect": true,
                "manageSandboxAnalyzer": true,
                "manageEventCorrelator": true,
                "manageComplianceManager": true,
                "manageExtendedEmailSecurity": true
            },
            "resell": {
                "manageXDRResell": true,
                "manageRemoteEnginesScanningResell": true,
                "manageContainerProtectionResell": true,
                "manageHyperDetectResell": true,
                "manageSandboxAnalyzerResell": true,
                "manageEventCorrelatorResell": true,
                "manageComplianceManagerResell": true,
                "manageExtendedEmailSecurityResell": true
            },
            "minimumUsage": {
                "endpointMonthlyUsage": 120
            },
            "assignedProductType": 0,
            "additionalProductTypes": [
                0
            ],
            "assignedProtectionModel": "aLaCarte",
            "additionalProtectionModels": [
                "aLaCarte",
                "mspSecure",
                "mspSecurePlus",
                "mspSecureExtra"
            ],
        },
        "customFields": {
            "referenceID": "004562",
            "vertical": "healthcare",
            "partner_type": "platinum",
            "security_level": "high",
            "payment_status": "goodstanding"
        },
        "duplicateClosedIncidentsOnUpdate": true
    },
    "jsonrpc": "2.0",
    "method": "createCompany",
    "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588"
}

A Partner company using a monthly subscription license, with an Endpoint Security product type, and a Secure protection model:

{
    "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": "partner@example.com",
        "accountFullName": "Partner account",
        "contactPerson": {
            "fullName": "Stephen Johnson",
            "email": "stephen.johnson@example.email.com",
            "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,
            "manageMobileSecurity": true,
            "edrDataRetention": 2,
            "ownUse": {
                "manageXDRIdentityProviders": true,
                "manageXDRProductivityApps": true,
                "manageXDRNetwork": true,
                "manageXDRCloudWorkloads": true,
                "manageHyperDetect": true,
                "manageSandboxAnalyzer": true,
                "manageEventCorrelator": true,
                "managePHASR": false,
                "manageEASM": false,
                "manageComplianceManager": true,
                "manageExtendedEmailSecurity": false
            },
            "resell": {
                "manageXDRResell": true,
                "manageHyperDetectResell": true,
                "manageSandboxAnalyzerResell": true,
                "manageEventCorrelatorResell": true,
                "managePHASRResell": true,
                "manageEASMResell": true,
                "manageComplianceManagerResell": true,
                "manageExtendedEmailSecurityResell": true
            },
            "minimumUsage": {
                "endpointMonthlyUsage": 120
            },
            "assignedProductType": 0,
            "additionalProductTypes": [
                0
            ],
            "assignedProtectionModel": "mspSecure",
            "additionalProtectionModels": [
                "mspSecure"
            ],
        },
        "customFields": {
            "referenceID": "004562",
            "vertical": "healthcare",
            "partner_type": "platinum",
            "security_level": "high",
            "payment_status": "goodstanding"
        },
        "duplicateClosedIncidentsOnUpdate": true
    },
    "jsonrpc": "2.0",
    "method": "createCompany",
    "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588"
}

A Customer company using an MDR yearly license:

{
    "params": {
        "type": 1,
        "name": "Customer LTD",
        "address": "Str Example No 1",
        "country": "US",
        "state": "US-CA",
        "phone": "0040740000000",
        "industry": 2,
        "enforce2FA": true,
        "skip2FAPeriod": 3,
        "accountEmail": "customer@example.com",
        "accountFullName": "Customer account",
        "contactPerson": {
            "fullName": "Stephen Johnson",
            "email": "stephen.johnson@example.email.com",
            "phoneNumber": "0040740000001",
            "companyRole": "Owner / President"
        },
        "licenseSubscription": {
            "type": 2,
            "licenseKey": "1b2b3c"
        },
        "mdrContactInformation": {
            "phoneNumber": {
                "countryPrefix": "+40",     
                "subscriberNumber": "112345"
            },
            "fullName": "Contact",
            "email": "mdrcontact@nebula.local",
            "emailVerificationCode": "43728676"
        },
        "customFields": {
            "referenceID": "004562",
            "vertical": "healthcare",
            "partner_type": "platinum",
            "security_level": "high",
            "payment_status": "goodstanding"
        },
        "duplicateClosedIncidentsOnUpdate": false
    },
    "jsonrpc": "2.0",
    "method": "createCompany",
    "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588"
}

A Customer with a monthly subscription and MDR enabled for own use:

{
    "params": {
        "type": 1,
        "name": "Customer LTD",
        "parentId": "5518f5f3b1a43d357e7b23c6",
        "address": "Str Example No 1",
        "country": "US",
        "state": "US-CA",
        "phone": "0040740000000",
        "industry": 2,
        "canBeManagedByAbove": true,
        "enforce2FA": true,
        "skip2FAPeriod": 3,
        "accountEmail": "customer@example.com",
        "accountFullName": "Customer account",
        "contactPerson": {
            "fullName": "Stephen Johnson",
            "email": "stephen.johnson@example.email.com",
            "phoneNumber": "0040740000001",
            "companyRole": "Owner / President"
        },
        "licenseSubscription": {
            "type": 3,
            "reservedSlots": 10,
            "endSubscription": "2020-04-14",
            "autoRenewPeriod": 12,
            "manageExchange": false,
            "manageEncryption": false,
            "manageRemoteEnginesScanning": false,
            "manageHyperDetect": true,
            "manageSandboxAnalyzer": true,
            "managePatchManagement": false,
            "manageEventCorrelator": true,
            "manageContainerProtection": false,
            "manageIntegrityMonitoring": true,
            "managePHASR": false,
            "manageEASM": false,
            "manageComplianceManager": true,
            "imDataRetention": 2,
            "manageExtendedEmailSecurity": true,
            "ownUse": {
                "manageXDRIdentityProviders": true,
                "manageXDRProductivityApps": true,
                "manageXDRNetwork": true,
                "manageXDRCloudWorkloads": true
            },
            "resell": {
                "manageXDRResell": false
            },
            "minimumUsage":{
                "endpointMonthlyUsage": 120
            },
            "assignedProductType": 0,
            "additionalProductTypes": [0],
            "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"
}

A Customer company with a monthly subscription, with the Bitdefender PHASR product type and the Patch Management and Compliance Manager add-ons for own use:

{
    "params": {
        "type": 1,
        "name": "Customer PHASR PatchMgmt",
        "parentId": "64259e19a1bf20af00069c",
        "address": "Str Example No 1",
        "phone": "0040740000000",
        "canBeManagedByAbove": true,
        "accountEmail": "customer_phasr@example.com",
        "accountFullName": "Customer account",
        "licenseSubscription": {
            "type": 3,
            "assignedProductType": 5,
            "additionalProductTypes": [],
            "ownUse": {
                "managePatchManagement": true,
	        "manageComplianceManager": true
            }
        }
    },
    "jsonrpc": "2.0",
    "method": "createCompany",
    "id": "a1b2c3d4-1111-2222-3333-4444555566"
}

Response:

{
    "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588",
    "jsonrpc": "2.0",
    "result": "5493dcd2b1a43df00b7b23c6"
}
In this section: