org.update

The org.update command is used to update an existing organization.

Requires Org Admin rights.

TR50 Request

{
  "cmd": {
    "command": "org.update",
    "params": {
      "key": "SYSTEM",
      "desc": "This is a new desc"
    }
  }
}

Request Parameters

Name Type Required Description
key String The key of the organization to update. If not specified, the organization associated with the session that initiated the request will be used.
name String The name of the organization.
desc String The description of the organization.
locale String The default locale of the organization.
customerRefId String The customer reference identifier.
defaultLocationPolicyId String   The default location policy identifier.
allowSubOrgs Boolean Whether this organization will allow child organizations to be attached to it.
data Object Opaque data store object with valid keys. If provided, overwrites the existing data object.
enabledApplications Array The array of the IDs of portal apps that are enabled for this organization.
root Boolean   When true, all descendant organization will inherit the configurations of this organizations rootSettings. NOTE: There can only be one root organization in the line of organizations; an organization cannot be root if any of it's ancestors or any of it's children have already been designated as root.
rootSettings.forceMfa Boolean   If set to true, use of this org and all child orgs will require the user to have MFA enabled. This configuration can only be used when the root parameter is set to true.
unset Array   An array of fields to unset. All optional parameters are allowed to be unset.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.

{
  "cmd": {
    "success": true
  }
}