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

类 RoleController

java.lang.Object

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

@RestController
@RequestMapping("/v1/auth/roles")
public class RoleController
extends Object

Role operation controller.

从以下版本开始:

1.2.0

作者:

nkorange

字段概要

字段

修饰符和类型	字段	说明
private final NacosRoleService	roleService

构造器概要

构造器

构造器	说明
RoleController(NacosRoleService roleService)

方法概要

修饰符和类型	方法	说明
Object	addRole(String role, String username)	Add a role to a user
Object	deleteRole(String role, String username)	Delete a role.
com.alibaba.nacos.api.model.Page<RoleInfo>	fuzzySearchRole(int pageNo, int pageSize, String username, String role)	Fuzzy query role information.
Object	getRoles(int pageNo, int pageSize, String username, String role)	Get roles list.
List<String>	searchRoles(String role)	Fuzzy matching role name .

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

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

字段详细资料

roleService

private final NacosRoleService roleService

构造器详细资料

RoleController

public RoleController(NacosRoleService roleService)

方法详细资料

getRoles

@GetMapping(params="search=accurate")
public Object getRoles(@RequestParam
 int pageNo,
 @RequestParam
 int pageSize,
 @RequestParam(name="username",defaultValue="")
 String username,
 @RequestParam(name="role",defaultValue="")
 String role)

Get roles list.

参数:

pageNo - number index of page

pageSize - page size

username - optional, username of user

role - optional role

返回:

role list

fuzzySearchRole

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

Fuzzy query role information.

参数:

pageNo - number index of page

pageSize - page size

username - username of user

role - role

返回:

role list

searchRoles

@GetMapping("/search")
public List<String> searchRoles(@RequestParam
 String role)

Fuzzy matching role name .

参数:

role - role id

返回:

role list

addRole

@PostMapping
public Object addRole(@RequestParam
 String role,
 @RequestParam
 String username)

Add a role to a user

This method is used for 2 functions: 1. create a role and bind it to GLOBAL_ADMIN. 2. bind a role to an user.

参数:

role - role name

username - username

返回:

Code 200 and message 'add role ok!'

deleteRole

@DeleteMapping
public Object deleteRole(@RequestParam
 String role,
 @RequestParam(name="username",defaultValue="")
 String username)

Delete a role. If no username is specified, all users under this role are deleted.

参数:

role - role

username - username

返回:

ok if succeed