Update User Features

Updates the feature entitlements for a particular user.

Update the list of Symphony feature entitlements for a particular user

post

Path parameters

uidinteger · int64Required

User ID as a decimal integer

Header parameters

sessionTokenstringRequired

Session authentication token.

Bodyobject[]

application/json

Entitlement feature record.

entitlmentstringOptionalExample: canCreatePublicRoom

enabledbooleanOptional

Whether this entitlement is enabled for the user.

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}/features/update

HTTPcURLJavaScriptPython

POST /pod/v1/admin/user/{uid}/features/update HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 156

[
  {
    "entitlment": "canCreatePublicRoom",
    "enabled": true
  },
  {
    "entitlment": "isExternalRoomEnabled",
    "enabled": false
  },
  {
    "entitlment": "canUpdateAvatar",
    "enabled": true
  }
]

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