Update User Status

Update the status of a particular user.
post
https://yourpodURL.symphony.com/pod
/v1/admin/user/{uid}/status/update
Update the status of a particular user
Parameters
Path
uid*
string
User ID as a decimal integer
Header
sessionToken*
string
Session authentication token.
Body
status
string
suspended
boolean
An optional attribute indicating whether the user is temporarily suspended or not. Since SBE 20.14.
suspendedUntil
integer
An optional unix timestamp until which the suspension is effective. Since SBE 20.14.
suspensionReason
string
An optional description of the suspension reason. Since SBE 20.14.
Body
Example
Schema
{
"status": "ENABLED",
"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.

📘 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.
Last modified 2mo ago