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

Path parameters

uidinteger · int64Required

User ID as a decimal integer

Header parameters

sessionTokenstringRequired

Session authentication token.

Bodyobject[]

application/json

Array of app entitlements to patch for a user

appIdstring · min: 1 · max: 256Required

Unique ID for the Application

Example: selerity

listedstring · enumOptional

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.

Default: KEEPExample: KEEPPossible values:

installstring · enumOptional

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.

Default: KEEPExample: truePossible values:

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /pod/v1/admin/user/{uid}/app/entitlement/list HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 157

[
  {
    "appId": "selerity",
    "listed": "KEEP",
    "install": true,
    "product": {
      "appId": "selerity",
      "name": "Premium",
      "sku": "AcDccU53SsY",
      "subscribed": false,
      "type": "premium"
    }
  }
]

[
  {
    "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 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".