Update User Status

Update the status of a particular user.

Update the status of a particular user

post

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

Path parameters

uidinteger · int64required

User ID as a decimal integer

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

suspendedboolean

An optional attribute indicating whether the user is temporarily suspended or not. Since SBE 20.14.

Example: true

suspendedUntilinteger · int64

An optional unix timestamp until which the suspension is effective. Since SBE 20.14.

Example: 1601546400

suspensionReasonstring

An optional description of the suspension reason. Since SBE 20.14.

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

statusstring · enum

Example: ENABLED

Options: ENABLED, DISABLED

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}/status/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","status":"ENABLED"}'

200

400

401

403

500

200

{
  "message": "OK"
}

Success

📘 Note

It is not possible to disable protected service users (keymanager and ceservice)

🚧 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.