Update User Status
Update the status of a particular user.
Path parameters
uidinteger · int64Required
User ID as a decimal integer
Header parameters
sessionTokenstringRequired
Session authentication token.
Body
statusstring · enumOptionalExample:
ENABLED
Possible values: suspendedbooleanOptionalExample:
An optional attribute indicating whether the user is temporarily suspended or not. Since SBE 20.14.
true
suspendedUntilinteger · int64OptionalExample:
An optional unix timestamp until which the suspension is effective. Since SBE 20.14.
1601546400
suspensionReasonstringOptionalExample:
An optional description of the suspension reason. Since SBE 20.14.
The user will be OOO due to a mandatory leave
Responses
200
Success
application/json
400
Client error, see response body for further details.
application/json
401
Unauthorized: Invalid session token.
application/json
403
Forbidden: Caller lacks necessary entitlement.
application/json
500
Server error, see response body for further details.
application/json
post
POST /pod/v1/admin/user/{uid}/status/update HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"status": "ENABLED",
"suspended": true,
"suspendedUntil": 1601546400,
"suspensionReason": "The user will be OOO due to a mandatory leave"
}
{
"format": "TEXT",
"message": "Success"
}
📘 NoteIt is not possible to disable protected service users (keymanager and ceservice)
🚧 Required PermissionsCalling 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 updated
Was this helpful?