Suspend User Account
Suspend or re-activate (unsuspend) a user account.
Released in Symphony 20.7.
Path parameters
userIdinteger · int64Required
User ID as a decimal integer
Header parameters
sessionTokenstringRequired
Session authentication token
Body
suspendedbooleanOptionalExample:
true
suspendedUntilinteger · int64OptionalExample:
1601546400
suspensionReasonstringOptionalExample:
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
put
PUT /pod/v1/admin/user/{userId}/suspension/update HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 113
{
"suspended": true,
"suspendedUntil": 1601546400,
"suspensionReason": "The user will be OOO due to a mandatory leave"
}
{
"format": "TEXT",
"message": "Success"
}
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 FieldsWhen 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 PermissionsCalling this endpoint requires a service account with the User Provisioning role. See Bot Permissions for a list of roles and their associated privileges.
Last updated
Was this helpful?