org.find

The org.find command is used to find and return an organization.

TR50 Request

{
  "cmd": {
    "command": "org.find",
    "params": {
      "key": "SYSTEM"
    }
  }
}

Request Parameters

Name Type Required Description
id String   The id identifying the organization.
key String   The key identifying the organization.
domain String   Looks up the org that has claimed this domain (e.g. example.com). Overrides the key parameter.
customerRefId String   Displays the orgs with the specified customerRefId.
Note: If none of the fields above are specified, org.find will return the organization you are currently in.

TR50 Response

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

{
  "cmd": {
    "success": true,
    "params": {
      "id": "52a1d3db169e1fd032179408",
      "key": "SYSTEM",
      "name": "deviceWISE Open Management",
      "profile": "52a1d3db169e1fd032179408",
      "lastLoginBy": "admin@devicewise.com",
      "lastLoginOn": "2021-12-06T08:40:43.885-05:00",
      "createdBy": "SYSTEM",
      "createdOn": "2013-12-06T08:40:43.885-05:00",
      "updatedBy": "SYSTEM",
      "updatedOn": "2021-12-05T08:40:43.885-05:00"
    }
  }
}

Response Parameters

Name Type Description
id String The id of the organization.
key String The key of the organization.
name String The name of the organization.
desc String The description of the organization.
profile String The unique identifier of the org profile of the organization.
owner String The unique identifier of the owner of the organization.
locale String The default locale of the organization.
smscAccessList Array An array of SMSCs that the org can use to send an SMS.
domain String The domain claimed by the organization.
tags Array The organization's tags.
customerRefId String The customer reference identifier.
defaultLocationPolicyId String The default location policy identifier.
allowSubOrgs Boolean Whether the organization allows child organizations.
allowSubOrgsDeletion Boolean Wether the child organizations can be deleted.
apiCounts Array Contains the number of organization api counts for the last thirty days.
counts Array Contains the organization counts of things, connections, and storage.
parent String The unique identifier of the parent organization.
parentKey String The key of the parent organization.

RootSettings Object

Name Type Description
forceMfa Boolean If set to true, all users of this org (and descendants of this org) must have MFA enabled. If a user fails to enable MFA, their access to the Management Portal and API commands will be severely limited.

PHP API

mixed TR50httpWorker::orgFind($key);