Update User Features

Updates the feature entitlements for a particular user.

Update the list of Symphony feature entitlements for a particular user

POSTyourpodURL.symphony.com/pod/v1/admin/user/{uid}/features/update

Path parameters

uid*integer (int64)

User ID as a decimal integer

Header parameters

Body

application/json

entitlmentstring

Example: "canCreatePublicRoom"

enabledboolean

Whether this entitlement is enabled for the user.

Example: true

Response

200400401403500

Success

Body

application/json

formatenum

Example: "TEXT"

TEXTXML

messagestring

Example: "Success"

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/user/{uid}/features/update', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "entitlment": "canCreatePublicRoom",
        "enabled": true
      },
      {
        "entitlment": "isExternalRoomEnabled",
        "enabled": false
      },
      {
        "entitlment": "canUpdateAvatar",
        "enabled": true
      }
    ]),
});
const data = await response.json();

Response

200400401403500

{
  "format": "TEXT",
  "message": "Success"
}

Request Example

curl -X POST \
https://acme.symphony.com/pod/v1/admin/user/7215545057281/features/update \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '[
  {
    "entitlment": "canCreatePublicRoom",
    "enabled": true
  },
  {
    "entitlment": "isExternalRoomEnabled",
    "enabled": true
  },
  {
    "entitlment": "delegatesEnabled",
    "enabled": true
  },
  {
    "entitlment": "isExternalIMEnabled",
    "enabled": true
  },
  {
    "entitlment": "sendFilesEnabled",
    "enabled": true
  },
  {
    "entitlment": "canUpdateAvatar",
    "enabled": true
  }
]'

🚧 Required Permissions

Calling this endpoint requires the User Provisioning role with ACCESS_USER_PROVISIONING_API privilege. See Bot Permissions for a list of roles and associated privileges.

Updating User Entitlements in Bulk

• When updating a large number of users, Symphony recommends parallelizing calls to this endpoint, typically to perform up to 300 calls concurrently.

• To reduce the effects of network latency, Symphony recommends executing these calls on a server in close geographic proximity to your pod.