Update the properties of existing company
Select
Modify the properties of an existing company
Path Parameters
- companyId int32 required
Id of the company to update
- application/json
Request Body
status object
deactivate booleanUsed to activate or deactivate the company. Not applicable for SaaS.
options object
disableBackup booleanEnable or disable backup. This option can only be set or unset for a deactivated company.
disableRestore booleanEnable or disable restore. This option can only be set or unset for a deactivated company.
disableLogin booleanEnable or disable login. This option can only be set or unset for a deactivated company.
- newName string
Used to change the name of a company
general object
newAlias stringThe company domain or NetBIOS name
emailSuffix stringSupported domains for the company
authcodeForInstallation booleanEnable or disable authcode for installation.
upnInsteadOfEmail booleanEnable or disable the use of User Pricipal Name in place of an email address.
twoFactorAuth object
enable booleanenable or disable two factor authentication. if enabled, all or userGroups value should be provided.
all booleanenable two factor authentication for every entity. if set to false when Two factor authentication is enabled, provide userGroupId or userGroupName. If both are provided, userGroupId is taken
userGroups object[]
id int32name stringresellerMode booleanEnable reseller mode. A reseller is a user or user groups who can operate multiple tenant environments. The service provider can assign one or more resellers as the tenant operator for a company. The reseller can switch to any of their assigned tenant environment and operate on the company as a tenant user. Once enabled, the reseller mode cannot be disabled.
enableDataEncryption booleanEnable or disable data encryption
autoDiscoverApp booleanEnable or Disable Auto Discover Applications.When Auto discover applications is enabled, each member server of this company is searched once every 24 hours to discover any applications that need to be backed up. For any newly-discovered and unprotected applications, the agent software is automatically installed on the server.
infrastructureType stringPossible values: [
RENTED_STORAGE
,OWN_STORAGE
,RENTED_AND_OWN_STORAGE
]These are different types of infrastructure provided for storage in companies. It can be rented from the provider, owned or can be a hybrid. Cannot move back to rented storage from owned storage and cannot move back to rented storage/owned storage from rented and owned storage.
supportedSolutions string[]Possible values: [
FILE_SERVER
,VIRTUALIZATION
,LAPTOP
,DATABASES
,EXCHANGE
,ARCHIVING
,CLOUD_APPS
,SHAREPOINT
,ACTIVATE
,ACTIVE_DIRECTORY
,OFFICE_365
,BIGDATA_APPS
,G_SUITE
,SALESFORCE
,REPLICATION
,KUBERNETES
]assignLaptopOwners stringPossible values: [
LOGGED_IN_ACTIVE_DIRECTORY_USERS
,FIRST_LOGGED_IN_USER
,LAPTOP_USER_GROUPS_AS_OWNERS
,DO_NOT_ASSIGN
]Used to assign owners to laptops automatically after installation. The owners can be all the logged in active directory users, the first user to login into the laptop after installation or the users belonging to the laptop's local user group list. The option to assign automatically can also be disabled.
serviceCommcells object[]
Service commcells associated with the master commcell.
id int32name stringsecurity object[]
user object
id int32name stringuserGroup object
id int32name stringrole object
id int32name stringemailSettings object
senderName stringName of the sender sending the email
senderEmail stringEmail id of the sender
sites object
primarySiteName stringPrimary site name
secondarySiteNames string[]Secondary site names
tenantOperators object[]
user object
id int32name stringuserGroup object
id int32name stringrole object
id int32name stringplans object[]
Provide a list of data protection plans to use for the company. The plans that are provided are the plans that the tenant administrator can choose from.
id int32name stringdefaultPlans object[]
Refers to default data protection plans to use for the company.
subtype stringPossible values: [
ANY
,DLO
,SERVER
,LAPTOP
,DATABASE
,SNAP
,FS_SERVER
,VSA_SERVER
,VSA_REPLICATION
,EXCHANGE_USER
,EXCHANGE_JOURNAL
,DATA_CLASSIFICATION
,E_DISCOVERY
,OFFICE_365
,ARCHIVER
,FSIBMIVTL
,DYNAMICS_365
,CDM
,ObjectStore
]id int32Id of the default plan. Either id or name can be provided. If both id and name are provided, id is given first preference.
name stringName of the default plan. Either id or name can be provided. If both id and name are provided, id is given first preference.
fileExceptions object
windows stringWindow file paths to be excluded.Comma separated string.
unix stringUnix file paths to be excluded.Comma separated string.
useCompanyGlobalFilter booleanEnable or disable the use of the file path filters on all subclients. By default, it is enabled when filters are added for either Windows or Unix or both.
- 200
- 400
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Bad Request
Requested Details not found