Update All User Apps

Updates all the application entitlements for a particular user.

Update the application entitlements for this user

post
Path parameters
uidanyrequired

User ID as a decimal integer

Header parameters
sessionTokenanyrequired

Session authentication token.

Body

Application Entitlements for the user

appIdstring · min: 1 · max: 256required

Unique ID for the Application

Example: selerity
appNamestring · min: 1 · max: 50optional

Name for this Application

Example: Selerity Context
listedbooleanrequired

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

Example: true
installbooleanrequired

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

Example: true
productsobject[]optional

Application Product

Example: [{"appId":"selerity","name":"Standard","subscribed":true,"type":"default"},{"appId":"selerity","name":"Premium","sku":"AcDccU53SsY","subscribed":false,"type":"premium"}]

Responses
post
curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/admin/user/{uid}/app/entitlement/list' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "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"
        }
      ]
    }
  ]'
[
  {
    "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 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.

Last updated

Was this helpful?