Update User Features

Updates the feature entitlements for a particular user.

Update the list of Symphony feature entitlements for a particular user

post

/v1/admin/user/{uid}/features/update

Path parameters

uidinteger · int64required

User ID as a decimal integer

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

entitlmentstring

Example: canCreatePublicRoom

enabledboolean

Whether this entitlement is enabled for the user.

Example: true

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/admin/user/{uid}/features/update' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '[{"entitlment":"canCreatePublicRoom","enabled":true},{"entitlment":"isExternalRoomEnabled","enabled":false},{"entitlment":"canUpdateAvatar","enabled":true}]'

200

400

401

403

500

200

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

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.