Note - Suspension
userSystemInfofrom the payload includes suspension info:
- if user is active, then the
suspendedattribute is set to false,
- if user is suspended, then the
suspendedattribute is set to true and both
suspensionReasonare as well included in the payload.
Please note that even if the suspendedUntil date is in the past, the user will remain suspended=true until he first logs on the client after the suspension ended. The suspended info are then automatically updated.
See the Suspend User Account endpoint for more information.
See End-User Account Attributes V2 for information about the user attributes.
Roles and Privileges
Calling this endpoint requires the ACCESS_USER_PROVISIONING_API and ACCESS_ADMIN_API privileges.
See Bot Permissions for a list of roles and associated privileges.