Skip to content

用户管理

1. 获取角色资源(getRoleResource)

前端: 谭海涛
后端: 冀晋星
url: /v1/homing/auth/employee/session/list-resource
备注: 员工会话-查询登录用户角色资源(企业-店铺-应用)

typescript
//! 注意,TS版本4^
import type { GetRoleResourceRes } from '@homing/web'

try {
    const data: GetRoleResourceRes = await homingClient.getRoleResource();
    console.log('角色资源信息', data);
} catch (error: any) {
    console.log(error, '调用失败' + error?.message);
}

参数说明

响应说明

字段名类型说明
resourceIdstring资源ID
resourceCodestring资源编码
permissionCodestring权限编码
labelstring资源显示名称
appIdstring应用ID
resourceTypestring资源类型
parentIdnumber父级资源ID
parentCodestring父级资源编码
treeGradenumber树形结构层级
treePathstring树形结构路径
iconstring图标
pathstring资源路径(可选)
categorystring资源分类
scopestring资源作用域
isPublicnumber是否公开:0-否,1-是
isDefnumber是否默认:0-否,1-是
sortValuenumber排序值
statenumber状态:0-禁用,1-启用
readonlynumber是否只读:0-否,1-是
createdBystring创建人
createdTimenumber创建时间(时间戳)
updatedBystring更新人
updatedTimenumber更新时间(时间戳)
childrenDatumChild[]子资源列表(递归)

2. 获取当前用户信息(getUserInfo)

前端: 谭海涛
后端: 冀晋星
url: /v1/homing/auth/employee/session/current
备注: 员工会话-当前会话信息

typescript
//! 注意,TS版本4^
import type { GetUserInfoRes } from '@homing/web'

try {
    const data: GetUserInfoRes = await client.getUserInfo();
    console.log(data,"用户信息")
} catch (error: any) {
    console.log(error, '调用失败' + error?.message);
}

参数说明

响应主体说明

字段名类型说明
userAccountUserAccount用户账号信息
employeeEmployee员工信息
sessionSession会话信息
tenantTenant租户信息
orgOrg机构信息
appApp应用信息
thirdThirdPartyBinding[]第三方绑定应用

1. UserAccount 字段说明

字段名类型说明
userCodestring用户编号
acctstring账号(手机号)
nicknamestring昵称
statenumber状态(1-启用,0-禁用)
descriptionstring备注
registerSourcenumber注册来源(1-系统预置,2-系统添加,3-企业添加)
socialUserIdstring社交标识(openId等)
passwordErrorLastTimestring最后一次输错密码时间
lastLoginTimestring最后登录时间
createdBystring创建人
createdTimestring创建时间
updatedBystring更新人
updatedTimestring更新时间

2. Employee 字段说明

字段名类型说明
employeeCodestring员工编号
jobNumberstring工号
tenantCodestring租户编码
bizMailstring企业邮箱
nicknamestring昵称
avatarstring头像
regionstring地区
addressstring地址详情
joinDatestring入职日期
leaveDatestring离职日期
positionStatusstring职位状态
workDescribestring工作描述
sourceTypestring身份来源
qrCodestring员工个人二维码
extattrstring自定义字段
readonlynumber内置
employeeStatusstring激活状态
statenumber状态
createdBystring创建人
createdTimestring创建时间
updatedBystring更新人
updatedTimestring更新时间
positionInfosIPositionInfo[]职位信息
orgInfoany[]机构信息
roleInfosany[]角色信息

3. Session 字段说明

字段名类型说明
tenantCodestring企业编码
orgCodestring机构编码
userCodestring用户编码
roleCodestring角色编码
appCodestring应用编码

4. Tenant 字段说明

字段名类型说明
tenantCodestring租户编号
tenantNamestring企业名称/租户名称
tenantBriefNamestring企业简称
dutystring责任人/联系人
mobilestring联系电话
emailstring联系邮箱
startTimestring开始时间
endTimestring结束时间
logostring企业logo地址
websitestring租户域名/绑定域名
provincestring省份
citystring城市
districtstring区县
addressstring详细地址
creditCodestring统一社会信用代码
descriptionstring企业简介
tenantStatusnumber租户审核状态
statenumber状态
readonlynumber内置
extattrstring自定义字段
createdBystring创建人
createdTimestring创建时间
updatedBystring更新人
updatedTimestring更新时间

5. Org 字段说明

字段名类型说明
createdBystring创建人
createdTimenumber创建时间
descriptionstring描述
dutystring负责人
emailstring负责人联系邮箱
fullNamestring机构全称
logostring机构logo地址
mobilestring负责人联系电话
orgCodestring机构code
orgNamestring机构名称
orgTypestring机构类型
parentCodestring父机构code
staffCodestring负责人工号
statenumber状态
tenantCodestring租户code
updatedBystring更新人
updatedTimenumber更新时间
tenantTenant租户信息

6. App 字段说明

字段名类型说明
appCodestring应用编号
appNamestring应用名称
nameCodestring应用标识
iconstring应用图标
contentstring应用详情
appTypestring应用类型
websitestring官网/应用地址
accessModestring接入方式
abbreviationstring应用简介
scopestring授权范围/公共应用
lablesstring应用标签
styleImagesstring应用截图
versionstring应用版本
descriptionstring备注
sortValuenumber排序
readonlynumber是否内置
isPublicnumber是否公共
statenumber状态
extattrstring自定义字段
createdBystring创建人
createdTimenumber创建时间
updatedBystring更新人
updatedTimenumber更新时间

7. ThirdPartyBinding 字段说明

字段名类型说明
thirdUserIdnumber第三方用户id
socialUserIdstring社交平台id
identityIdnumber用户id
socialTypestring社交平台类型

8. positionInfos 字段说明

字段名类型说明
positionIdstring职位标识
positionCodestring职位编码
positionNamestring职位名称
positionTypestring职位分类
descriptionstring描述
sortValuestring显示排序
statestring状态

基于 MIT 许可证发布