com.alibaba.nacos.console.controller

类 UserController

java.lang.Object

com.alibaba.nacos.console.controller.UserController

@RestController(value="user")
 @RequestMapping(value={"/v1/auth","/v1/auth/users"})
public class UserController
extends Object

User related methods entry.

作者:

wfnuser, nkorange

构造器概要

构造器

构造器和说明
UserController()

方法概要

限定符和类型	方法和说明
Object	createUser(String username, String password) Create a new user.
Object	deleteUser(String username) Delete an existed user.
Object	getUsers(int pageNo, int pageSize) Get paged users.
Object	login(String username, String password, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request) Login to Nacos This methods uses username and password to require a new token.
List<String>	searchUsersLikeUsername(String username) Fuzzy matching username.
com.alibaba.nacos.common.model.RestResult<String>	updatePassword(String oldPassword, String newPassword) 已过时。
Object	updateUser(String username, String newPassword, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request) Update an user.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

UserController

public UserController()

方法详细资料

createUser

@PostMapping
public Object createUser(@RequestParam
                                       String username,
                                       @RequestParam
                                       String password)

Create a new user.

参数:

username - username

password - password

返回:

ok if create succeed

抛出:

IllegalArgumentException - if user already exist

从以下版本开始:

1.2.0

deleteUser

@DeleteMapping
public Object deleteUser(@RequestParam
                                         String username)

Delete an existed user.

参数:

username - username of user

返回:

ok if deleted succeed, keep silent if user not exist

从以下版本开始:

1.2.0

updateUser

@PutMapping
public Object updateUser(@RequestParam
                                      String username,
                                      @RequestParam
                                      String newPassword,
                                      javax.servlet.http.HttpServletResponse response,
                                      javax.servlet.http.HttpServletRequest request)
                               throws IOException

Update an user.

参数:

username - username of user

newPassword - new password of user

response - http response

request - http request

返回:

ok if update succeed

抛出:

IllegalArgumentException - if user not exist or oldPassword is incorrect

IOException

从以下版本开始:

1.2.0

getUsers

@GetMapping
public Object getUsers(@RequestParam
                                    int pageNo,
                                    @RequestParam
                                    int pageSize)

Get paged users.

参数:

pageNo - number index of page

pageSize - size of page

返回:

A collection of users, empty set if no user is found

从以下版本开始:

1.2.0

login

@PostMapping(value="/login")
public Object login(@RequestParam
                                                  String username,
                                                  @RequestParam
                                                  String password,
                                                  javax.servlet.http.HttpServletResponse response,
                                                  javax.servlet.http.HttpServletRequest request)
                                           throws com.alibaba.nacos.auth.exception.AccessException

Login to Nacos

This methods uses username and password to require a new token.

参数:

username - username of user

password - password

response - http response

request - http request

返回:

new token of the user

抛出:

com.alibaba.nacos.auth.exception.AccessException - if user info is incorrect

updatePassword

@PutMapping(value="/password")
 @Deprecated
public com.alibaba.nacos.common.model.RestResult<String> updatePassword(@RequestParam(value="oldPassword")
                                                                                                                      String oldPassword,
                                                                                                                      @RequestParam(value="newPassword")
                                                                                                                      String newPassword)

已过时。

Update password.

参数:

oldPassword - old password

newPassword - new password

返回:

Code 200 if update successfully, Code 401 if old password invalid, otherwise 500

searchUsersLikeUsername

@GetMapping(value="/search")
public List<String> searchUsersLikeUsername(@RequestParam
                                                                          String username)

Fuzzy matching username.

参数:

username - username

返回:

Matched username