1.说明

在平台中组织架构对外提供了API接口,下面对这些接口进行一下说明。

接口调用时请先阅读 API调用文档

2. 详细介绍

接口代码在 jpaas-user项目下

com.redxun.user.restapi.OrgApiController

接口说明如下:

2.1.同步用户组

接口路径:api/api-user/restApi/user/addOrUpdGroups

调用方法:POST

请求头:

请求头 数据
token 产生的token数据
Content-Type application/json;charset=utf-8

参数:
请求体:

{
    "tenantId": "",
    "account":"",
    "groups":[{
         id:"",---用户组id,唯一标识
         code:"",----用户组业务主键
         name:"",---用户组名称
         parentId:""--上级id,
         dimId:"" --维度ID,
         status:""
      },
      {
            id:"",---用户组id,唯一标识
             code:"",----用户组业务主键
             name:"",---用户组名称
             parentId:""--上级id,
             dimId:"",
             status:""
      }
    ]
}
参数名 参数值 必要性
tenantId 租户id
account 操作人员账号
groups 用户组列表
id 用户组ID,唯一标识
code 用户组业务主键,唯一标识
name 用户组名称
parentId 上级用户组id,顶级为0
dimId 维度ID 否,如果不填,默认为 1
status 状态 可以用值为 ENABLED 启用,DISABLED 禁用 否,默认为 ENABLED

接口功能:用户组同步功能包括新增和更新功能。
(1)、根据用户组id和用户组业务主键查询平台是否存在数据,不存在则新增,否在为更新。
(2)、更新时除更新传过来的数据外,也会对此组织下的所有子组织进行路径(path)的更新

2.2 删除用户组

接口路径:api/api-user/restApi/user/deleteGroups

请求方法: POST

请求头 数据
token 产生的token数据
Content-Type application/json;charset=utf-8

参数:
请求体:

{
    "tenantId": "",
    "account":"",
    "groupIds":"1,2"
}
参数名 参数值 必要性
tenantId 租户id,默认webApp
account 操作人员账号
groupIds 用户组ID列表

接口功能:根据用户组ID进行删除用户组。
(1)、删除用户组的同时,也会删除此用户组关联的【用户关系】、【组关系】。
(2)、用户所属的主部门为此用户组,则不删除该条关联的用户关系记录。

2.3 同步用户

接口路径:api/api-user/restApi/user/addOrUpdUsers

请求方法: POST

请求头 数据
token 产生的token数据
Content-Type application/json;charset=utf-8

参数:
请求体:

{
    "tenantId": "",
    "account":"",
    "users":[
            {
            "userId":"10001",
            "account":"zhangsan",
            "fullname":"张三",
            "sex":"male",
            "email":"358****@qq.com""mobile":"1307763****",
            "qq":"358****",
            "address":"广东省广州市海珠区",
            "wxOpenId":"zhangsan",
            "depId":"1",
            "status":"1",
            "relations":[{"relationType":"1","dimId":"1","part1":"2","remove":true},{"relationType":"3","dimId":"","part1":"1297745181147734017"}]
            }
    ]
}
参数名 参数值 必要性
tenantId 租户id
account 操作人员账号
users 用户对象列表
account 用户账号,唯一标识
fullname 用户名称
sex 性别:male(男)、female(女)
email 电子邮箱
mobile 手机号
qq qq
address 通讯地址
wxOpenId 用户所在企业微信账号
depId 用户主部门
status 用户状态:1(在职) 0(离职)
relations 用户关系
relationType 关系类型Id
dimId 用户组维度Id
part1 当前方Id

接口功能:用户同步功能包括新增和更新功能。
(1)、根据用户账号查询平台是否存在数据,不存在则新增,否在为更新。
(2)、新增时用户初始化密码为1,如果存在主部们和所属用户组数据,则新建对应用户组关系数据。
(3)、更新时除更新传过来的数据外,如果存在主部们和所属用户组数据,则更新维度为1的用户组关系数据
(4)、用户关系:用户和组、用户和用户(指定上级),需配置关系类型与当前方id,用户与用户时不需要指定维度id
例如上方请求体中,用户关系中配置的是用户的行政组织与上级
(5)、指定用户与组关系时,用户组不能为主部门,否则无效。

2.4 删除用户

接口路径:api/api-user/restApi/user/deleteUsers

请求方法: POST

请求头 数据
token 产生的token数据
Content-Type application/json;charset=utf-8

参数:
请求体:

{
    "tenantId": "",
    "account":"",
    "userAccounts":"zhangsan,lisi,wangwu"
}
参数名 参数值 必要性
tenantId 租户id,默认webApp
account 操作人员账号
userAccounts 用户账号列表

接口功能:根据用户账号进行删除用户。
(1)、删除用户的同时,也会删除此用户关联用户组所有关系。

2.5 查询所有用户

接口路径:api/api-user/restApi/user/getUsers

请求方法: POST

请求头 数据
token 产生的token数据
Content-Type application/json;charset=utf-8

参数:
请求体:

{
    "pageNo": 1,
    "pageSize": 10,
    "params": {},
    "sortField": "",
    "sortOrder": "asc"
}
参数名 参数值 必要性
pageNo 当前页码
pageSize 分页大小
params 条件,例:Q_FULLNAME__S_LK
sortField 排序字段
sortOrder 排序(asc/desc)

接口功能:查询所有的用户。

2.6 查询所有用户组

接口路径:api/api-user/restApi/user/getGroups

请求方法: POST

请求头 数据
token 产生的token数据
Content-Type application/json;charset=utf-8

参数:
请求体:

{
    "pageNo": 1,
    "pageSize": 10,
    "params": {},
    "sortField": "",
    "sortOrder": "asc"
}
参数名 参数值 必要性
pageNo 当前页码
pageSize 分页大小
params 条件,例:Q_NAME__S_LK
sortField 排序字段
sortOrder 排序(asc/desc)

接口功能:查询所有的用户组。

2.7 同步租户

接口路径:api/api-user/restApi/user/syncTenant
请求方法 :POST

请求头:

请求头 数据
token 产生的token数据
Content-Type text/plain;charset=utf-8

参数:
请求体:

[ {instId:"",nameCn:"",instNo:"",parentId:"",status:"ENABLED" } ]
参数名 参数值
instId 租户ID
nameCn 租户名称
instNo 租户实例编码
parentId 上级租户ID
status ENABLED, DISABLED ,可用,不可用,这个可以不传,默认为 ENABLED

接口功能:同步租户。

文档更新时间: 2021-03-17 22:21   作者:zyg