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.

{
  "1": {
    "success": true,
    "params": {       
       "id": "52a1d3db169e1fd032179408",
       "startTs": "0001-01-01T00:00:00Z",
       "endTs": null,
       "message": "",
       "priority": 0,
       "level": "normal",
       "ackOnDismissal": false,
       "ackMessage": "",
       "ackButton": "",
       "global": false,
       "orgProfileIds": ["52a1d3db169e1fd032179407"],
       "rootOrgIds": ["52a1d3db169e1fd032179409"],
       "orgIds": ["52a1d3db169e1fd032179410"],
       "createdBy": SYSTEM,
       "createdOn": "0001-01-01T00:00:00Z",
       "updatedBy": SYSTEM,
       "updatedOn": "0001-01-01T00:00:00Z"
     }
  }
}

Response Parameters

Name Type Description
id String The identifier of the alert.
startTs String The start of the timestamp. Time at which the alert is started.
endTs String The end of the timestamp. Time at which the alert is finished.
message String The message of the alert.
priority Integer The priority of the alert.
level String The level of the alert, possible levels: "normal", "info", "warning", and "critical".
ackOnDismissal Boolean Shows if the alert can be acknowledged.
ackMessage String The message that is provided when the alert is acknowledged.
ackButton String The button information is provided when the alert is acknowledged.
global Boolean True if the alert should be shown to all users.
orgProfileId Array An array of organization profile Ids that should be shown this alert.
rootOrgIds Array An array of root organization Ids that should be shown this alert.
orgIds Array An array of organization Ids that should be shown this alert.
triggerExecCounts Array Contains the number of organization trigger executions for the last thirty days.
createdBy String The creator of the record.
createdOn String The timestamp of the creation of the record.
updatedBy String The updater of the record, email, or at least the name of the entity.
updatedOn String The timestamp of the update of the record.

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);