程序包 com.alibaba.nacos.plugin.auth.impl.controller

类 UserController

java.lang.Object

com.alibaba.nacos.plugin.auth.impl.controller.UserController

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

User related methods entry.

作者:

wfnuser, nkorange

字段概要

字段

修饰符和类型	字段	说明
private final AuthConfigs	authConfigs
private final org.springframework.security.authentication.AuthenticationManager	authenticationManager	已过时。
private final IAuthenticationManager	iAuthenticationManager
private final TokenManagerDelegate	jwtTokenManager
private final NacosRoleService	roleService
private final NacosUserService	userDetailsService

构造器概要

构造器

构造器	说明
UserController(TokenManagerDelegate jwtTokenManager, NacosUserService userDetailsService, NacosRoleService roleService, AuthConfigs authConfigs, IAuthenticationManager iAuthenticationManager, org.springframework.security.authentication.AuthenticationManager authenticationManager)

方法概要

修饰符和类型	方法	说明
Object	createAdminUser(String password)	Create a admin user only not exist admin user can use.
Object	createUser(String username, String password)	Create a new user.
Object	deleteUser(String username)	Delete an existed user.
com.alibaba.nacos.api.model.Page<User>	fuzzySearchUser(int pageNo, int pageSize, String username)
com.alibaba.nacos.api.model.Page<User>	getUsers(int pageNo, int pageSize, String username)	Get paged users.
private boolean	hasPermission(String username, jakarta.servlet.http.HttpServletRequest request)
Object	login(String username, String password, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request)	Login to Nacos
List<String>	searchUsersLikeUsername(String username)	Fuzzy matching username.
Object	updateUser(String username, String newPassword, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request)	Update an user.

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

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

字段详细资料

jwtTokenManager

private final TokenManagerDelegate jwtTokenManager

userDetailsService

private final NacosUserService userDetailsService

roleService

private final NacosRoleService roleService

authConfigs

private final AuthConfigs authConfigs

iAuthenticationManager

private final IAuthenticationManager iAuthenticationManager

authenticationManager

@Deprecated
private final org.springframework.security.authentication.AuthenticationManager authenticationManager

已过时。

构造器详细资料

UserController

public UserController(TokenManagerDelegate jwtTokenManager,
 NacosUserService userDetailsService,
 NacosRoleService roleService,
 AuthConfigs authConfigs,
 IAuthenticationManager iAuthenticationManager,
 org.springframework.security.authentication.AuthenticationManager authenticationManager)

方法详细资料

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

createAdminUser

@PostMapping("/admin")
public Object createAdminUser(@RequestParam(required=false)
 String password)

Create a admin user only not exist admin user can use.

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,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.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

hasPermission

private boolean hasPermission(String username,
 jakarta.servlet.http.HttpServletRequest request)
                       throws org.springframework.web.HttpSessionRequiredException,
AccessException

抛出:

org.springframework.web.HttpSessionRequiredException

AccessException

getUsers

@GetMapping(params="search=accurate")
public com.alibaba.nacos.api.model.Page<User> getUsers(@RequestParam
 int pageNo,
 @RequestParam
 int pageSize,
 @RequestParam(name="username",required=false,defaultValue="")
 String username)

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

fuzzySearchUser

@GetMapping(params="search=blur")
public com.alibaba.nacos.api.model.Page<User> fuzzySearchUser(@RequestParam
 int pageNo,
 @RequestParam
 int pageSize,
 @RequestParam(name="username",required=false,defaultValue="")
 String username)

login

@PostMapping("/login")
public Object login(@RequestParam
 String username,
 @RequestParam
 String password,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.http.HttpServletRequest request)
             throws AccessException,
IOException

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

抛出:

AccessException - if user info is incorrect

IOException

searchUsersLikeUsername

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

Fuzzy matching username.

参数:

username - username

返回:

Matched username