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

PUTyourpodURL.symphony.com/pod/v1/admin/user/{userId}/suspension/update

Path parameters

userId*integer (int64)

User ID as a decimal integer

Header parameters

Body

application/json

suspendedboolean

Example: true

suspendedUntilinteger (int64)

Example: 1601546400

suspensionReasonstring

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

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/{userId}/suspension/update', {
    method: 'PUT',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403500

{
  "format": "TEXT",
  "message": "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.