Update User Status

Update the status of a particular user.

Update the status of a particular user

post

Path parameters

uidinteger · int64Required

User ID as a decimal integer

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

statusstring · enumOptionalExample: ENABLEDPossible values:

suspendedbooleanOptional

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

Example: true

suspendedUntilinteger · int64Optional

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

Example: 1601546400

suspensionReasonstringOptional

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

Example: 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

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

HTTPcURLJavaScriptPython

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"
}

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