org.create

The org.create command is used to create a new organization.

Requires Org Admin rights.

TR50 Request

{
  "cmd": {
    "command": "org.create",
    "params": {
      "key": "SYSTEM",
      "name": "deviceWISE Open Management"
    }
  }
}

Request Parameters

Name Type Required Description
key String Yes The key of the organization (minimum length of 4, will be capitalized). Org keys are globally unique.
name String Yes 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.
extra String Optional extra data string that will be stored in the creation record for this org.
enabledApplications Array The array of the IDs of portal apps that are enabled for this organization.
profile String The org profile for the organization. Requires super-ops+ role.
smscAccessList Array An array of smsc access list that the org uses to send SMS. Requires Super-Ops+ role
suspended Boolean Whether this organization is suspended. Can only be set by a super-admin.

To create a root level organization you need Super-ops permission. A root level organization requires a profile to be specified.

rootSettings Parameters

Name Type Required Description
forceMfa Boolean   If set to true, use of this org and all child orgs will require the user to have MFA enabled.

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,
    "params": {
      "id": "53c1d3db169e1fd032100002"
    }
  }
}

Response Parameters

Name Type Required Description
id String Yes The unique identifier of the created organization.