Suspend User Account

Suspend or re-activate (unsuspend) a user account.
Released in Symphony 20.7.
put
https://yourpodURL.symphony.com/pod
/v1/admin/user/{userId}/suspension/update
Update the status of suspension of a particular user
Parameters
Path
userId*
string
User ID as a decimal integer
Header
sessionToken*
string
Session authentication token
Body
suspended
boolean
suspendedUntil
integer
suspensionReason
string
Body
Example
Schema
{
"suspended": true,
"suspendedUntil": 1601546400,
"suspensionReason": "The user will be OOO due to a mandatory leave"
}
Responses
200: OK
Success
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
500: Internal Server Error
Server error, see response body for further details.
The value of the suspendedUntil field should be provided in milliseconds

Request Examples

curl -X PUT \
'https://devx1.symphony.com/pod/v1/admin/user/12987981107250/suspension/update' \
-H 'sessionToken: SESSION_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"suspended": true,
"suspensionReason": "The user will be OOO due to a mandatory leave",
"suspendedUntil": 1601546400000
}'
curl -X PUT \
'https://devx1.symphony.com/pod/v1/admin/user/suspension/update' \
-H 'sessionToken: SESSION_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"suspended": false
}'

📘 Required Fields

When suspending a user account, suspended=true, all three body parameters are required. When activating a user account, suspended=false, the other two remaining body parameters are not required.

🚧 Required Permissions

Calling this endpoint requires a service account with the User Provisioning role. See Bot Permissions for a list of roles and their associated privileges.
Last modified 2mo ago