1.0 KiB
//////////////////////////////////////////////////////////////////////////////// /// @startDocuBlock JSF_api_user_fetch /// @brief fetch the properties of a user. /// /// @RESTHEADER{GET /_api/user/{user}, Fetch User} /// /// @RESTURLPARAMETERS /// /// @RESTURLPARAM{user,string,required} /// The name of the user /// /// @RESTDESCRIPTION /// /// Fetches data about the specified user. /// /// The call will return a JSON object with at least the following attributes on success: /// /// - user: The name of the user as a string. /// - active: An optional flag that specifies whether the user is active. /// - extra: An optional JSON object with arbitrary extra data about the user. /// - changePassword: An optional flag that specifies whether the user must /// change the password or not. /// /// @RESTRETURNCODES /// /// @RESTRETURNCODE{200} /// The user was found /// /// @RESTRETURNCODE{404} /// The user with the specified name does not exist /// /// @endDocuBlock ////////////////////////////////////////////////////////////////////////////////