portal_app.list

The portal_app.list command lists the enabled portal applications. By default, the list will contain portal applications that your organization has enabled and the mandatory portal applications are also listed as enabled applications.

TR50 Request

{
  "1": {
    "command": "portal_app.list",
    "params": {
      "offset": 0,
      "limit": 20,
      "sort": ["name"]
    }
  }
}

Request Parameters

Name	Type	Description
offset	Integer	The starting list offset, used for pagination. Defaults to 0 if not specified.
limit	Integer	Limits the number of results returned. The maximum you can set is 2000. Defaults to 2000.
sort	Array	sort is an optional parameter that defines the sort order of the result set. It allows to arrange the list in either ascending(+) or descending(-) order. It is possible to sort portal.app.list in the following categories: name, and url
showAll	Boolean	Requires Super-Admin. Returns all available portal applications on the platform.
showAllEnabled	Boolean	Requires Super-Ops. Returns all enabled portal applications on the platform.
showByProfile	Boolean	Requires Org Admin. Returns all portal applications enabled by an organization's profile.

TR50 Response

If the command is sent successfully a success message, the count, and an array of portal application records is returned. Otherwise, an error and error message will be returned.

{
  "1": {
    "success": true,
    "params": {
      "count": 2,
      "result: [
        {
          "id": "59a06544b5143858b3af5941",
          "name": "Management Portal",
          "description": "The IoT Management Portal",
          "icon": "cloud",
          "iconColor": "#ffffff",
          "color": "#00cccc",
          "url": "https://portal.example.com/sso",
          "callbackUrl": "https://portal.example.com/callback",
          "publisher": "Acme App Publisher",
          "version": "1.0",
          "status": "Production",
          "screenshots": ["https://img.example.com/screenshot1.png", "https://img.example/com/screenshot2.png"],
          "image": "https://img.example.com/image1.png",
          "enabled": true
        },
        ...
      ]
    }
  }
}

Response Parameters

Name	Type	Description
count	Integer	The total number of portal applications. Used for paging.
result	Array	The array of portal applications.

Result array object

Name	Type	Description
id	String	The id of the portal application.
name	String	The name of the portal application.
description	String	The description of the portal application.
icon	String	The icon to display for the portal application.
iconColor	String	The color to associate with the portal icon, RGB hex encoded.
color	String	The color to associate with the portal application, RGB hex encoded.
url	String	The URL that will process the SSO process.
callbackUrl	String	The callback URL for the portal application.
publisher	String	The name of the publisher of the portal application.
version	String	The version of the portal application.
status	String	The string describing the status of the application. "Production", for example.
screenshots	Array	An array of URLs to screenshots to use in the app center.
image	String	URL to an image to represent the application in the app center.
enabled	Boolean	If the portal application is available to org profiles/orgs.
MandatoryApplications	String	Mandatory applications assigned to the Org profile.