Update All User Apps

Updates all the application entitlements for a particular user.

Update the application entitlements for this user

post

Path parameters

uidinteger · int64Required

User ID as a decimal integer

Header parameters

sessionTokenstringRequired

Session authentication token.

Bodyobject[]

application/json

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

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

post

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

HTTPcURLJavaScriptPython

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

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

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.