Update All User Apps

Updates all the application entitlements for a particular user.

Update the application entitlements for this user

POSTyourpodURL.symphony.com/pod/v1/admin/user/{uid}/app/entitlement/list

Path parameters

uid*integer (int64)

User ID as a decimal integer

Header parameters

Body

application/json

appId*string

Unique ID for the Application

appNamestring

Name for this Application

listed*boolean

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

install*boolean

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

productsProductList (array of Product (object))

Response

200400401403500

Success

Body

application/json

appId*string

Unique ID for the Application

appNamestring

Name for this Application

listed*boolean

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

install*boolean

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

productsProductList (array of Product (object))

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/user/{uid}/app/entitlement/list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "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"
          }
        ]
      }
    ]),
});
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"
      }
    ]
  }
]

As shown in the example, the updated user application entitlements should be included in the data parameter.

❗️ Important

Please, consider the following information before using this endpoint:

The endpoint is designed to update all app entitlements of a user using a single API call. It is not meant to modify one single entitlement for a user.

However, it is possible to do this using the Patch Update User Apps endpoint.