user.org.list

The user.org.list command is used to list the user's access to an organization.

TR50 Request

{
  "cmd": {
    "command": "user.org.list",
    "params": {
      "userId": "52a1d3db169e1fd03217940d"
    }
  }
}

Request Parameters

Name Type Required Description
userId String Yes The object Id of the user.

TR50 Response

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

{
  "cmd": {
    "success": true,
    "params": {
      "result": [
        {
          "addedBy": "SYSTEM",
          "addedOn": "2013-12-06T08:40:43.885-05:00",
	   "allowSubOrgAccess": false,
          "orgId": "52a1d3db169e1fd032179408",
          "orgKey": "SYSTEM",
          "isOrgAdmin": false
          "roles": ["52a1d3db169e1fd03217940a", "52a1d3db169e1fd03217941b"],
          "tags": ["tag1", "tag2"]
        }
      ]
    }
  }
}

Response Result Parameters

Name Type Description
addedBy String The creator of the organization.
addedOn String The timestamp of the organization.
allowSubOrgAccess Boolean If true, the user has access to the sub-orgs of the current organization.
If false, the user will not be able to access the sub-orgs of the current organization.
orgId String The organization's object Id.
orgKey String The organization's key.
isOrgAdmin Boolean If the user is an Org-Admin.
roles Array An array of role object Ids
tags Array An array of security tags