Skip to main content

Update the properties of existing company​

Modify the properties of an existing company

Path Parameters
  • companyId int32 required

    Id of the company to update

Request Body
  • status object
  • deactivate boolean

    Used to activate or deactivate the company.

  • options object
  • disableBackup boolean

    Enable or disable backup. This option can only be set or unset for a deactivated company.

  • disableRestore boolean

    Enable or disable restore. This option can only be set or unset for a deactivated company.

  • disableLogin boolean

    Enable 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 string

    The company domain or NetBIOS name

  • emailSuffix string

    Supported domains for the company

  • authcodeForInstallation boolean

    Enable or disable authcode for installation.

  • upnInsteadOfEmail boolean

    Enable or disable the use of User Pricipal Name in place of an email address.

  • twoFactorAuth object
  • enable boolean

    enable or disable two factor authentication. if enabled, all or userGroups value should be provided.

  • all boolean

    enable 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 int32
  • name string
  • resellerMode boolean

    Enable 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 boolean

    Enable or disable data encryption

  • autoDiscoverApp boolean

    Enable 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 string

    Possible 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 string

    Possible 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 int32
  • name string
  • security object[]
  • user object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • role object
  • id int32
  • name string
  • emailSettings object
  • senderName string

    Name of the sender sending the email

  • senderEmail string

    Email id of the sender

  • sites object
  • primarySiteName string

    Primary site name

  • secondarySiteNames string[]

    Secondary site names

  • tenantOperators object[]
  • user object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • role object
  • id int32
  • name string
  • plans 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 int32
  • name string
  • defaultPlans object[]

    Refers to default data protection plans to use for the company.

  • subtype string

    Possible 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 int32

    Id of the default plan. Either id or name can be provided. If both id and name are provided, id is given first preference.

  • name string

    Name 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 string

    Window file paths to be excluded.Comma separated string.

  • unix string

    Unix file paths to be excluded.Comma separated string.

  • useCompanyGlobalFilter boolean

    Enable 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.

Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/company/:companyid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
companyId — path required
Body
{

  "status": {

    "deactivate": true,

    "options": {

      "disableBackup": true,

      "disableRestore": true,

      "disableLogin": true

    }

  },

  "newName": "string",

  "general": {

    "newAlias": "string",

    "emailSuffix": "string",

    "authcodeForInstallation": true,

    "upnInsteadOfEmail": true,

    "twoFactorAuth": {

      "enable": true,

      "all": true,

      "userGroups": [

        {

          "id": 0,

          "name": "string"

        }

      ]

    },

    "resellerMode": true,

    "enableDataEncryption": true,

    "autoDiscoverApp": true,

    "infrastructureType": "RENTED_STORAGE",

    "supportedSolutions": [

      "FILE_SERVER"

    ],

    "assignLaptopOwners": "LOGGED_IN_ACTIVE_DIRECTORY_USERS",

    "serviceCommcells": [

      {

        "id": 0,

        "name": "string"

      }

    ]

  },

  "security": [

    {

      "user": {

        "id": 0,

        "name": "string"

      },

      "userGroup": {

        "id": 0,

        "name": "string"

      },

      "role": {

        "id": 0,

        "name": "string"

      }

    }

  ],

  "emailSettings": {

    "senderName": "string",

    "senderEmail": "string"

  },

  "sites": {

    "primarySiteName": "string",

    "secondarySiteNames": [

      "string"

    ]

  },

  "tenantOperators": [

    {

      "user": {

        "id": 0,

        "name": "string"

      },

      "userGroup": {

        "id": 0,

        "name": "string"

      },

      "role": {

        "id": 0,

        "name": "string"

      }

    }

  ],

  "plans": [

    {

      "id": 0,

      "name": "string"

    }

  ],

  "defaultPlans": [

    {

      "subtype": "ANY",

      "id": 0,

      "name": "string"

    }

  ],

  "fileExceptions": {

    "windows": "string",

    "unix": "string",

    "useCompanyGlobalFilter": true

  }

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/company/:companyId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "status": {
    "deactivate": true,
    "options": {
      "disableBackup": true,
      "disableRestore": true,
      "disableLogin": true
    }
  },
  "newName": "string",
  "general": {
    "newAlias": "string",
    "emailSuffix": "string",
    "authcodeForInstallation": true,
    "upnInsteadOfEmail": true,
    "twoFactorAuth": {
      "enable": true,
      "all": true,
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    },
    "resellerMode": true,
    "enableDataEncryption": true,
    "autoDiscoverApp": true,
    "infrastructureType": "RENTED_STORAGE",
    "supportedSolutions": [
      "FILE_SERVER"
    ],
    "assignLaptopOwners": "LOGGED_IN_ACTIVE_DIRECTORY_USERS",
    "serviceCommcells": [
      {
        "id": 0,
        "name": "string"
      }
    ]
  },
  "security": [
    {
      "user": {
        "id": 0,
        "name": "string"
      },
      "userGroup": {
        "id": 0,
        "name": "string"
      },
      "role": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "emailSettings": {
    "senderName": "string",
    "senderEmail": "string"
  },
  "sites": {
    "primarySiteName": "string",
    "secondarySiteNames": [
      "string"
    ]
  },
  "tenantOperators": [
    {
      "user": {
        "id": 0,
        "name": "string"
      },
      "userGroup": {
        "id": 0,
        "name": "string"
      },
      "role": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "defaultPlans": [
    {
      "subtype": "ANY",
      "id": 0,
      "name": "string"
    }
  ],
  "fileExceptions": {
    "windows": "string",
    "unix": "string",
    "useCompanyGlobalFilter": true
  }
}'