Package com.brihaspathee.zeus.web.resource.interfaces

Interface UserAPI

All Known Implementing Classes:
UserAPIImpl
@RequestMapping("/api/v1/zeus/security/user") @Validated public interface UserAPI
Created in Intellij IDEA User: Balaji Varadharajan Date: 05, July 2022 Time: 4:02 PM Project: Zeus Package Name: com.brihaspathee.zeus.web.resource.interfaces To change this template use File | Settings | File and Code Template

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserDto>>
    createUser(com.brihaspathee.zeus.security.model.UserDto userDto)
    Create a new User
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserList>>
    getAllUsers()
    Get all the users that are present in the system
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserList>>
    getUserById(UUID userId)
    Get the user by user id
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserList>>
    getUserByUsername(String username)
    Get the user by username
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserDto>>
    updateUser(UUID userId, com.brihaspathee.zeus.security.model.UserDto userDto)
    Update an existing user

  • Method Details

    • getAllUsers

      @GetMapping org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserList>> getAllUsers()
      Get all the users that are present in the system
      Returns:

    • getUserById

      @GetMapping("/user-id/{userId}") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserList>> getUserById(@PathVariable UUID userId)
      Get the user by user id
      Returns:

    • getUserByUsername

      @GetMapping("/username/{username}") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserList>> getUserByUsername(@PathVariable String username)
      Get the user by username
      Returns:

    • createUser

      @PostMapping org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserDto>> createUser(@RequestBody com.brihaspathee.zeus.security.model.UserDto userDto)
      Create a new User
      Returns:

    • updateUser

      @PutMapping("/{userId}") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.UserDto>> updateUser(@PathVariable UUID userId, @RequestBody com.brihaspathee.zeus.security.model.UserDto userDto)
      Update an existing user
      Returns: