Site users management - Suspend users

Use this method to suspend user(s) in a site 

Request URI

PUT /api/3/sites/{siteid}/users/suspended

Request Parameters

Request Body 

A list of user ids of users who are to be suspended from the site. Send a transaction id's object to send a list of user id's. The userid can be obtained by calling get all site users API.

Response

The server will respond with 200 OK http response in the case of success , and a (4xx/5xx) response in the case of a partial success or a complete failure

The response body will contain transaction status information for each user

Notes : 

    1) In case of success, it will display the following message "User suspended successfully."

      2) When the user id is not correct, it will display the following message "User Id provided is Invalid"

      3) When a given user id is not a site participant, it will display the following message "User with the specified User ID does not exist in the site"

      4) When a user id is already suspended from the site, it will display the following message "The selected user is already suspended"

      5) When a user id is not in system or the user is not active, it will display the following message "User with this User ID does not exist in system or User is not active"

      6) When a given user id is a system administrator or has created the given site it will display the following message "The selected user is either a System Administrator or is the creator of this site and cannot be suspended. "

      7)  In any other exception, it will display the following message "Internal server error"