Suspend User Account

Suspend or re-activate (unsuspend) a user account.

Released in Symphony 20.7.

Update the status of suspension of a particular user

put

/v1/admin/user/{userId}/suspension/update

Path parameters

userIdinteger · int64required

User ID as a decimal integer

Header parameters

sessionTokenstringrequired

Session authentication token

Body

suspendedboolean

Example: true

suspendedUntilinteger · int64

Example: 1601546400

suspensionReasonstring

Example: The user will be OOO due to a mandatory leave

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'yourpodURL.symphony.com/pod/v1/admin/user/{userId}/suspension/update' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '{"suspended":true,"suspendedUntil":1601546400,"suspensionReason":"The user will be OOO due to a mandatory leave"}'

200

400

401

403

500

200

{
  "format": "TEXT",
  "message": "User suspended with success"
}

Success

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.