Update User Status

Update the status of a particular user.

Update the status of a particular user

POSTyourpodURL.symphony.com/pod/v1/admin/user/{uid}/status/update

Path parameters

uid*integer (int64)

User ID as a decimal integer

Header parameters

Body

application/json

statusenum

ENABLEDDISABLED

suspendedboolean

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

suspendedUntilinteger (int64)

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

suspensionReasonstring

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

Response

200400401403500

Success

Body

application/json

formatenum

TEXTXML

messagestring

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/user/{uid}/status/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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.