Class UserApiController

java.lang.Object
com.bluebell.greenhouse.planter.controllers.security.UserApiController
@RestController @RequestMapping("${bluebell.base.api.controller.endpoint}/user") @CrossOrigin(origins="*", methods={GET,DELETE,POST,PUT}) public class UserApiController extends Object
API controller for User.
Version:
3.0.6
Author:
Stephen Prizio

  • Constructor Details

    • UserApiController

      public UserApiController()

  • Method Details

    • getUser

      @GetMapping("/get") public org.springframework.http.ResponseEntity<UserDTO> getUser(@RequestParam("username") String username)
      Returns a ResponseEntity containing a User with the given username.
      Parameters:
      username - username
      Returns:
      ResponseEntity

    • getTimeZones

      @GetMapping("/time-zones") public org.springframework.http.ResponseEntity<TreeSet<String>> getTimeZones()
      Returns a ResponseEntity containing all of the ZoneId.
      Returns:
      ResponseEntity

    • getLanguages

      @GetMapping("/languages") public org.springframework.http.ResponseEntity<TreeSet<String>> getLanguages()
      Returns a ResponseEntity containing all of the Languages.
      Returns:
      ResponseEntity

    • getRecentTransactions

      @GetMapping("/recent-transactions") public org.springframework.http.ResponseEntity<List<TransactionDTO>> getRecentTransactions(@RequestParam(value="count",defaultValue="10",required=false) int count, @ResolvedPortfolio PortfolioRequestContext context)
      Returns a list of the recent transactions for all of the User's Accounts.
      Parameters:
      count - limit
      context - PortfolioRequestContext
      Returns:
      ResponseEntity

    • getUsersPaged

      @GetMapping("/search-users") public org.springframework.http.ResponseEntity<PaginatedUserDTO> getUsersPaged(@ModelAttribute UserSearchRequest searchRequest)
      Returns a ResponseEntity containing the Users filtered.
      Parameters:
      searchRequest - UserSearchRequest
      Returns:
      ResponseEntity

    • postCreateUser

      @PostMapping("/create") public org.springframework.http.ResponseEntity<UserDTO> postCreateUser(@Valid @RequestBody @Valid CreateUpdateUserDTO data)
      Creates a new User.
      Parameters:
      data - CreateUpdateUserDTO
      Returns:
      ResponseEntity

    • putUpdateUser

      @PutMapping("/update") public org.springframework.http.ResponseEntity<UserDTO> putUpdateUser(@Valid @RequestBody @Valid CreateUpdateUserDTO data, @AuthenticatedUser AuthenticatedUserRef userRef)
      Updates an existing User.
      Parameters:
      data - CreateUpdateUserDTO
      userRef - AuthenticatedUserRef
      Returns:
      ResponseEntity

    • putUpdateUserByAdministrator

      @PutMapping("/update-by-administrator") public org.springframework.http.ResponseEntity<UserDTO> putUpdateUserByAdministrator(@Valid @RequestBody @Valid CreateUpdateUserDTO data)
      Updates an existing User not assigned to the current session.
      Parameters:
      data - CreateUpdateUserDTO
      Returns:
      ResponseEntity

    • putUpdateUserAccessByAdministrator

      @PutMapping("/update-access-by-administrator") public org.springframework.http.ResponseEntity<UserDTO> putUpdateUserAccessByAdministrator(@Valid @RequestBody @Valid UpdateUserAccessDTO data)
      Updates an existing User's access information.
      Parameters:
      data - UpdateUserAccessDTO
      Returns:
      ResponseEntity

    • postRotateApiKeyByAdministrator

      @PostMapping("/rotate-api-key-by-administrator") public org.springframework.http.ResponseEntity<UserDTO> postRotateApiKeyByAdministrator(@Valid @RequestBody @Valid RotateApiTokenDTO data)
      Rotates an existing User's api token.
      Parameters:
      data - RotateApiTokenDTO
      Returns:
      ResponseEntity

    • deleteUserByAdministrator

      @DeleteMapping("/delete-by-administrator") public org.springframework.http.ResponseEntity<Void> deleteUserByAdministrator(@RequestParam("username") String username)
      Deletes an existing empty User.
      Parameters:
      username - username
      Returns:
      ResponseEntity