Update User Apps

Released in SBE 20.13. Updates the application entitlements for a particular user. Supports partial update.

Update unique entitlement of an app for this user. Entitlement can be installation, visibility or product

patch

/v1/admin/user/{uid}/app/entitlement/list

Path parameters

uidinteger · int64required

User ID as a decimal integer

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

appIdstring · min: 1 · max: 256required

Unique ID for the Application

Example: selerity

productobject

Application Product

listedstring · enum · default: KEEP

If "TRUE", this application will be listed in the appstore for this user. If "FALSE", this application will be hidden in the appstore. If "KEEP" or not set, the current value is kept. If "REMOVE", it will be removed from user settings and the pod level setting's value will be used.

Example: KEEP

Options: TRUE, FALSE, KEEP, REMOVE

installstring · enum · default: KEEP

If "TRUE", this application will be installed for this user. If "FALSE", this application will not be installed for this user. If "KEEP" or not set, the current value is kept. If "REMOVE", it will be removed from user settings and the pod level setting's value will be used.

Example: true

Options: TRUE, FALSE, KEEP, REMOVE

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'yourpodURL.symphony.com/pod/v1/admin/user/{uid}/app/entitlement/list' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '[{"appId":"selerity","product":{"appId":"selerity","name":"Premium","sku":"AcDccU53SsY","subscribed":false,"type":"premium"},"listed":"KEEP","install":true}]'

200

400

401

403

500

200

[
  {
    "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"
      }
    ]
  }
]

Success

As shown in the example, the request body is structured as an array [] of individual apps to be updated.

📘 Info

Unlike Update All User Apps endpoint, it is not mandatory to provide in the body request all app entitlements for a given app. You can therefore update only one or several of them among the following body params: "install", "listed", or "products".

The "product" field is not required but cannot be set to "null". When provided, please specify all subfields specified such as in the example: "appId", "subscribed", "type", "sku", and "name".