org.create

Requires organization administrator rights.

TR50 Request

{
  "cmd": {
    "command": "org.create",
    "params": {
      "key": "SYSTEM",
      "name": "Test Open Management",
      "profile": "52a1d3db169e1fd032179408"
    }
  }
}

Request Parameters


Name	Type	Required	Description
key	String	Yes	The key of the organization that is four characters or more.
name	String	Yes	The name of the organization.
profile	String		The org profile for the organization.
desc	String		The description of the organization.
locale	String		The default locale of the organization.
domain	String		The domain to claim (for example, example.com). Must be unique among all organizations. Requires super-ops rights.
customerRefId	String		The customer reference identifier.
subOrg	Boolean		Whether to create this organization as a child of the current session's organization. If false, requires super-ops rights.
allowSubOrgs	Boolean		Whether to enable this organization to have child organizations attached to it.
apiRateLimit	Integer		The API rate limit for the organization in calls per second. Can only be set by a super-ops.
extra	String		Optional extra data string that will be stored in the creation record for this org.
suspended	Boolean		Whether this organization is suspended. Can only be set by a super-admin.
suspendedReason	String		The reason displayed if the organization is suspended, optionally. Can only be set by a super-admin.

Users with super-ops rights can create a root level organization (an organization that is not a sub-organization of another organization). A root level organization requires a profile to be specified.

TR50 Response

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

{
  "cmd": {
    "success": true,
    "params": {
      "id": "53c1d3db169e1fd032100002"
    }
  }
}

Response Parameters


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