cn.gtmap.gtc.clients

接口 UserManagerClient

@FeignClient(name="account")
 @RequestMapping(value="/account/rest/v1/users")
public interface UserManagerClient

版本:

1.0, 2018/7/4

作者:

yangyang

方法概要

限定符和类型	方法和说明
Boolean	checkUserExist(String username)
Boolean	checkUserPassword(String password, String id)
UserDto	createNewUser(UserDto userDetail)
Boolean	deleteUser(String id)
Boolean	disabledUser(String id)
Boolean	enabledUser(String id)
List<RoleDto>	findAllRoles(String id)
List<OrganizationDto>	findOrgs(String id)
List<RoleDto>	findRoles(String id)
List<OrganizationDto>	findUserGradingRootOrgs(String username, Integer enabled)
AuthorityDto	findUserModuleAuthority(String id, String moduleId)
List<OrganizationDto>	findUserRootOrgs(String username) 已过时。 as of 1.2.3, in favor of using findUserGradingRootOrgs(java.lang.String, java.lang.Integer)
UserDto	getCurrentUser()
UserDto	getUserByUsername(String username) 已过时。 中文名账号调用出错 used UserManagerClient.getUserDetailByUsername()
UserDto	getUserDetail(String id)
UserDto	getUserDetailByUsername(String username)
String	getUserSign(String username)
boolean	importUsers(List<UserDto> userDtos)
org.springframework.data.domain.Page<UserDto>	listGradeUsers(org.springframework.data.domain.Pageable pageable, String inquirer, String username, String alias, Integer enabled)
org.springframework.data.domain.Page<UserDto>	listGradingOrgUsers(org.springframework.data.domain.Pageable pageable, String inquirer, String orgId, String username, String alias, Integer enabled)
List<UserDto>	listUserByIds(List<String> ids)
List<UserDto>	listUserByUserNames(List<String> usernames)
org.springframework.data.domain.Page<UserDto>	listUsers(String username, String alias, Integer enabled, org.springframework.data.domain.Pageable pageable)
Boolean	lockUser(String id)
BaseResultDto	sendSms(String username, String phone, String msgType)
BaseResultDto	smsVerify(String username, String phone, String msgType, String code)
Boolean	unlockUser(String id)
UserDto	updateUser(String id, UserDto userDetail)
UserDto	updateUserInfo(String id, UserDto userDetail)
Boolean	updateUserOrgs(String id, List<String> orgIds)
UserDto	updateUserPassword(String username, String password)
Boolean	updateUserRoles(String id, List<String> roleIds)
Boolean	updateUserSign(String id, String signId)

方法详细资料

listUsers

@GetMapping(value="/list")
org.springframework.data.domain.Page<UserDto> listUsers(@RequestParam(name="username",required=false)
                                                                                    String username,
                                                                                    @RequestParam(name="alias",required=false)
                                                                                    String alias,
                                                                                    @RequestParam(name="enabled",required=false)
                                                                                    Integer enabled,
                                                                                    org.springframework.data.domain.Pageable pageable)

参数:

username - 用户名/账户

alias - 姓名

enabled - 1：正常 0：禁用

返回:

listGradeUsers

@GetMapping(value="/grading-users")
org.springframework.data.domain.Page<UserDto> listGradeUsers(org.springframework.data.domain.Pageable pageable,
                                                                                                  @RequestParam(name="inquirer")
                                                                                                  String inquirer,
                                                                                                  @RequestParam(name="username",required=false)
                                                                                                  String username,
                                                                                                  @RequestParam(name="alias",required=false)
                                                                                                  String alias,
                                                                                                  @RequestParam(name="enabled",required=false)
                                                                                                  Integer enabled)

参数:

inquirer - 操作人用户名/账户

username - 用户名/账户

alias - 姓名

enabled - 1：正常 0：禁用 null, 全部

返回:

listGradingOrgUsers

@GetMapping(value="/grading-org-users")
org.springframework.data.domain.Page<UserDto> listGradingOrgUsers(org.springframework.data.domain.Pageable pageable,
                                                                                                           @RequestParam(name="inquirer")
                                                                                                           String inquirer,
                                                                                                           @RequestParam(name="orgId",required=false)
                                                                                                           String orgId,
                                                                                                           @RequestParam(name="username",required=false)
                                                                                                           String username,
                                                                                                           @RequestParam(name="alias",required=false)
                                                                                                           String alias,
                                                                                                           @RequestParam(name="enabled",required=false)
                                                                                                           Integer enabled)

参数:

inquirer - 操作人用户名/账户

orgId - 组织id

username - 用户名/账户

alias - 姓名

enabled - 1：正常 0：禁用 null: 全部

返回:

createNewUser

@PostMapping
UserDto createNewUser(@RequestBody
                                    UserDto userDetail)

参数:

userDetail - 用户信息

返回:

importUsers

@PostMapping(value="/import")
boolean importUsers(@RequestBody
                                                   List<UserDto> userDtos)

参数:

userDtos - 用户信息

返回:

updateUser

@PutMapping(value="/{id}")
UserDto updateUser(@PathVariable(value="id")
                                               String id,
                                               @RequestBody
                                               UserDto userDetail)

参数:

id - 用户id

userDetail - 用户信息

返回:

updateUserInfo

@PatchMapping(value="/{id}")
UserDto updateUserInfo(@PathVariable(value="id")
                                                     String id,
                                                     @RequestBody
                                                     UserDto userDetail)

参数:

id - 用户id

userDetail - 用户信息

返回:

updateUserPassword

@PatchMapping(value="/password")
UserDto updateUserPassword(@RequestParam(value="username")
                                                             String username,
                                                             @RequestParam(value="password")
                                                             String password)

参数:

username - 账号

password - 密码

返回:

getUserDetail

@GetMapping(value="/{id}")
UserDto getUserDetail(@PathVariable(value="id")
                                                  String id)

参数:

id - 用户id

返回:

getUserByUsername

@Deprecated
 @GetMapping(value="/username/{username}")
UserDto getUserByUsername(@PathVariable(value="username")
                                                                                   String username)

已过时。 中文名账号调用出错 used UserManagerClient.getUserDetailByUsername()

参数:

username - 用户名/账户

返回:

getUserDetailByUsername

@GetMapping(value="/username")
UserDto getUserDetailByUsername(@RequestParam(value="username")
                                                                String username)

参数:

username - 用户名/账户

返回:

getCurrentUser

@GetMapping(value="/current-user")
UserDto getCurrentUser()

返回:

enabledUser

@PostMapping(value="/{id}/enabled")
Boolean enabledUser(@PathVariable(name="id")
                                                         String id)

参数:

id - 用户

返回:

disabledUser

@PostMapping(value="/{id}/disabled")
Boolean disabledUser(@PathVariable(name="id")
                                                           String id)

参数:

id - 用户

返回:

deleteUser

@DeleteMapping(value="/{id}")
Boolean deleteUser(@PathVariable(value="id")
                                                  String id)

参数:

id - 用户

返回:

updateUserSign

@PostMapping(value="/{id}/sign")
Boolean updateUserSign(@PathVariable(name="id")
                                                         String id,
                                                         @RequestParam(name="signId")
                                                         String signId)

参数:

id - 用户

signId - 签名文件上传文档中心后生成

返回:

getUserSign

@GetMapping(value="/sign")
String getUserSign(@RequestParam(name="username")
                                               String username)

参数:

username - 用户名

返回:

listUserByUserNames

@PostMapping(value="/username-list")
List<UserDto> listUserByUserNames(@RequestBody
                                                                        List<String> usernames)

参数:

usernames - 用户名列表

返回:

listUserByIds

@PostMapping(value="/id-list")
List<UserDto> listUserByIds(@RequestBody
                                                            List<String> ids)

参数:

ids - id列表

返回:

updateUserRoles

@PostMapping(value="/{id}/roles")
Boolean updateUserRoles(@PathVariable(value="id")
                                                           String id,
                                                           @RequestBody
                                                           List<String> roleIds)

参数:

id - 用户

roleIds - 角色id列表

返回:

updateUserOrgs

@PostMapping(value="/{id}/orgs")
Boolean updateUserOrgs(@PathVariable(value="id")
                                                         String id,
                                                         @RequestBody
                                                         List<String> orgIds)

参数:

id - 用户

orgIds - 组织id列表

返回:

findAllRoles

@GetMapping(value="/{id}/all-roles")
List<RoleDto> findAllRoles(@PathVariable(value="id")
                                                                 String id)

参数:

id - 用户

返回:

findRoles

@GetMapping(value="/{id}/roles")
List<RoleDto> findRoles(@PathVariable(value="id")
                                                          String id)

参数:

id - 用户

返回:

findOrgs

@GetMapping(value="/{id}/orgs")
List<OrganizationDto> findOrgs(@PathVariable(name="id")
                                                                String id)

参数:

id - 用户

返回:

findUserRootOrgs

@Deprecated
 @GetMapping(value="/root-orgs")
List<OrganizationDto> findUserRootOrgs(@RequestParam(name="username")
                                                                                      String username)

已过时。 as of 1.2.3, in favor of using findUserGradingRootOrgs(java.lang.String, java.lang.Integer)

参数:

username - 用户名/账户

返回:

findUserGradingRootOrgs

@GetMapping(value="/grading-root-orgs")
List<OrganizationDto> findUserGradingRootOrgs(@RequestParam(name="username")
                                                                                       String username,
                                                                                       @RequestParam(name="enabled",required=false)
                                                                                       Integer enabled)

参数:

username - 用户名/账户

enabled - 0:禁用， 1启用， null:全部

返回:

checkUserPassword

@PostMapping(value="/check-password")
Boolean checkUserPassword(@RequestParam(name="password")
                                                                 String password,
                                                                 @RequestParam(name="id")
                                                                 String id)

参数:

password - 密码

id - 用户

返回:

checkUserExist

@GetMapping(value="/existed")
Boolean checkUserExist(@RequestParam(name="username")
                                                      String username)

参数:

username - 用户名/账户

返回:

findUserModuleAuthority

@GetMapping(value="/{id}/module-authority")
AuthorityDto findUserModuleAuthority(@PathVariable(name="id")
                                                                                  String id,
                                                                                  @RequestParam(name="moduleId")
                                                                                  String moduleId)

参数:

id - 用户id

返回:

lockUser

@PostMapping(value="{id}/lock")
Boolean lockUser(@PathVariable(name="id")
                                                  String id)

参数:

id - 用户id

返回:

unlockUser

@PostMapping(value="{id}/unlock")
Boolean unlockUser(@PathVariable(name="id")
                                                      String id)

参数:

id - 用户id

返回:

sendSms

@PostMapping(value="/sms")
BaseResultDto sendSms(@RequestParam(name="username",required=false)
                                                  String username,
                                                  @RequestParam(name="phone",required=false)
                                                  String phone,
                                                  @RequestParam(name="msgType")
                                                  String msgType)

参数:

username - 用户名，注册时可不填，其他情况必填

phone - 注册时必填，其余可为空

msgType - 消息类型 USER_REGISTER： 用户注册， USER_MODIFY_PWD： 修改密码

返回:

smsVerify

@GetMapping(value="/sms-verify")
BaseResultDto smsVerify(@RequestParam(name="username",required=false)
                                                          String username,
                                                          @RequestParam(name="phone",required=false)
                                                          String phone,
                                                          @RequestParam(name="msgType")
                                                          String msgType,
                                                          @RequestParam(name="code")
                                                          String code)

参数:

username - 用户名，注册时可不填，其他情况必填

phone - 注册时必填，其余可为空

msgType - 消息类型 USER_REGISTER： 用户注册， USER_MODIFY_PWD： 修改密码

code - 验证码

返回: