用户管理
提供用户管理功能的接口及数据模型定义。
Maven坐标
xml
<dependency>
<groupId>com.ikingtech.framework</groupId>
<artifactId>sdk-user-api</artifactId>
</dependency>
接口列表
接口地址 | 接口说明 |
---|---|
/system/user/add | 新增,新增成功后返回编号。 |
/system/user/delete | 删除。 |
/system/user/update | 更新。 |
/system/user/info/update | 更新用户基本信息。 |
/system/user/list/page | 分页查询,没有查询结果时返回空列表。 |
/system/user/detail/id | 查询详情,数据不存在时仍然返回成功,数据为null。 |
/system/user/bind/wechat/wechat-union-id | 向用户信息中添加微信UnionId |
/system/user/bind/social | 绑定第三方平台标识信息 |
/system/user/password/reset | 重置密码,将指定用户的密码重置为初始密码,平台默认的用户初始密码为Abc123++ |
/system/user/password/reset/username | 重置密码,将指定用户的密码重置为初始密码。 |
/system/user/password/modify | 修改密码,修改指定用户的密码,需同时指定用户原密码和新密码,系统会校验原密码是否正确,正确时才会修改为新密码。 |
/system/user/lock | 锁定用户,调用此接口锁定用户后,用户变为永久锁定状态,必须由管理员或具有用户管理权限角色的其他用户手动解锁。 |
/system/user/unlock | 解锁用户,此接口在用户被手动锁定或因多次登录失败被锁定后调用。 |
/system/user/role-id/list/user-id | 查询角色编号(用户编号),没有查询结果时返回空列表。 |
/system/user/info/list/all | 查询用户信息(全量),没有查询结果时返回空列表。 |
/system/user/info/list/role-ids | 查询用户(多角色编号),仅包含用户基本信息,不包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/list/role-ids | 查询用户(多角色编号),包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/id/list/role-ids | 查询用户编号(多角色编号),没有查询结果时返回空列表。 |
/system/user/id/list/role-id | 查询用户编号(角色编号),没有查询结果时返回空字符串。 |
/system/user/info/list/dept-ids | 查询基本信息列表(部门编号),仅包含用户基本信息,不包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/id/list/dept-id | 查询用户编号(单部门编号),没有查询结果时返回空列表。 |
/system/user/info/list/post-ids | 查询用户编号(单部门编号),没有查询结果时返回空列表。 |
/system/user/id/list/post-id | 查询用户编号(单岗位编号),没有查询结果时返回空列表。 |
/system/user/info/list/menu-ids | 查询用户(多菜单编号),仅包含用户基本信息,不包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/info/list/menu-id | 查询用户(菜单编号),仅包含用户基本信息,不包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/info/list/phones | 查询用户(多手机号),仅包含用户基本信息,不包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/info/list/ids | 查询用户(多用户编号),仅包含用户基本信息,不包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/info/map/ids | 查询用户(多用户编号),仅包含用户基本信息,不包含用户角色/部门/岗位信息,没有查询结果时返回空列表。 |
/system/user/map/ids | 查询用户Map(多用户编号)。 |
/system/user/list/ids | /system/user/list/ids |
/system/user/info/id | 查询用户(用户编号),数据不存在时仍然返回成功,数据为null。 |
/system/user/social/list/user-id | 查询基本信息(用户身份凭证),数据不存在时仍然返回成功,数据为null。 |
/system/user/info/social | 查询基本信息(用户社交号),数据不存在时仍然返回成功,数据为null。 |
/system/user/info/credential | 查询基本信息(用户身份凭证),数据不存在时仍然返回成功,数据为null。 |
/system/user/info/login-user | 查询基本信息(登录用户),指定的用户不存在时仍然返回成功,数据为null。 |
/system/user/config/update | 新增或更新配置。 |
/system/user/configs/list/login-user | 查询配置(登录用户),没有查询结果时返回空列表。 |
/system/user/recent/tenant | 保存用户最近一次登录时选择的租户信息 |
/system/user/info/list/usernames | 保存用户最近一次登录时选择的租户信息 |
/system/user/recent/tenant-login/ | 根据用户编号获取最近登录租户信息 |
扩展组件
🔨用户管理扩展组件指的是当出现用户的"增加","修改","删除" 操作时,用户管理服务通过接口通知到其他的业务,同时其他业务需要实现UserInfoEventReminder
接口。
- Maven坐标
xml
<dependency>
<groupId>com.ikingtech.framework</groupId>
<artifactId>sdk-user-extension</artifactId>
</dependency>
- 例子:
java
@Slf4j
public class UserInfoEventListener implements UserInfoEventReminder {
@Override
public void add(UserInfoEvent user) {
log.info("收到用户添加事件,用户信息:{}", user);
}
@Override
public void delete(String id) {
log.info("收到用户删除事件,用户id:{}", id);
}
@Override
public void update(UserInfoEvent user) {
log.info("收到用户更新事件,用户信息:{}", user);
}
}
- 配置
yaml
iking:
framework:
user:
extension-enable: true #是否启用用户管理扩展组件
用户管理RPC接口
提供用户管理模块的远程调用接口。
- Maven坐标
xml
<dependency>
<groupId>com.ikingtech.framework</groupId>
<artifactId>sdk-user-rpc</artifactId>
</dependency>