List User Apps

Returns the list of Symphony application entitlements for this user.

Get the list of application entitlements for this user

GETyourpodURL.symphony.com/pod/v1/admin/user/{uid}/app/entitlement/list
Path parameters
uid*integer (int64)

User ID as a decimal integer

Header parameters
Response

Success

Body
appId*string

Unique ID for the Application

Example: "selerity"
appNamestring

Name for this Application

Example: "Selerity Context"
listed*boolean

if true, this application will be listed in the appstore for this user. Otherwise, this application will be hidden in the appstore.

Example: true
install*boolean

if true, it indicate this application is installed for this user. Otherwise, this user does not have this application installed.

Example: true
productsProductList (array of Product (object))
Request
const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/user/{uid}/app/entitlement/list', {
    method: 'GET',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();
Response
[
  {
    "appId": "djApp",
    "appName": "Dow Jones",
    "listed": true,
    "install": false
  },
  {
    "appId": "selerity",
    "appName": "Selerity Context",
    "listed": true,
    "install": true,
    "products": [
      {
        "appId": "selerity",
        "name": "Standard",
        "subscribed": true,
        "type": "default"
      },
      {
        "appId": "selerity",
        "name": "Premium",
        "sku": "AcDccU53SsY",
        "subscribed": false,
        "type": "premium"
      }
    ]
  }
]

🚧 Important

This endpoint returns all enabled entitlements for a specific user, returning both the global and the custom settings. Currently, it is not possible to identify by API response whether the returned entitlements are global or custom.

To know more about how to modify an app entitlement per user, and how to reset the app entitlements for that user to the default global settings, refer to Update User Apps

Last updated