用户批量导入接口
更新时间: 2022-12-05 15:45:48
阅读 3375
接口说明:
用于将客户的用户列表导入到用户系统里,实现双方部分用户信息的同步,如果导入的用户已在系统中,会做更新操作,否则做添加操作
基本信息:
属性 | 值 |
---|---|
API | /api/dash/user/batchImport |
Method | POST |
请求参数:
字段名称 | 参数类型 | 参数说明 |
---|---|---|
token | String | 鉴权token,该用户必须是系统里的域管理员 |
users | Array | 用户列表 |
projectId | Int(Optional) | 默认导入到系统里,如果有projectId,会导入某个项目里 |
groupIds | Array(Optional) | 用户组id列表,可选参数,希望将导入的用户放到那些用户组里 |
defaultPassword | String(Optional) | 用户默认密码,可选参数,如果不给,则不设置密码,用户无法直接登陆(单点登录不需要传此参数) |
roleNames | Array(Optional) | 将用户绑定到指定一组角色(限定为根目录的一级角色) |
rolePaths | Array |
将用户绑定到指定一组角色, 每一个角色由一个路径的数组表示,数组的最后一个元素是角色名 |
delRoleNames | Array(Optional) | 为用户删除一组角色(限定为根目录的一级角色) |
delRolePaths | Array |
为用户删除一组角色, 每一个角色由一个路径的数组表示,数组的最后一个元素是角色名 |
permissionRoleNames | Array(Optional) | 将用户绑定到指定的一组数据权限(限定为根目录的行级权限) |
permissionRolePaths | Array |
将用户绑定到指定的一组数据权限, 每一个数据权限由一个路径的数组表示,数组的最后一个元素是数据权限名 |
delPermissionRoleNames | Array(Optional) | 为用户删除一组数据权限(限定为根目录的行级权限) |
delPermissionRolePaths | Array |
为用户删除一组数据权限, 每一个数据权限由一个路径的数组表示,数组的最后一个元素是数据权限名 |
systemRoleIds | Array(Optional) | 将用户绑定到指定的系统角色,1 表示项目管理员,2表示编辑者,3 表示阅览者 |
domainId | Number(Optional) | 域ID,企业域用户可指定 |
domainName | String(Optional) | 域名,企业域用户可指定 |
用户对象参数说明:
字段名称 | 参数类型 | 参数说明 |
---|---|---|
String(Optional) | 邮箱,有些企业该字段会是唯一 | |
phone | String(Optional) | 手机号码 |
uniqueId | String | 用来判断用户唯一性的字段,可能是email,phone,uid等字段其中之一 |
password | String(Optional) | 可以设置或更新用户的登录密码,该配置项的优先级高于defaultPassword (单点登录不需要设置此选项) |
nick | String(Optional) | 用户昵称 |
department | String(Optional) | 用户所属部门 |
company | String(Optional) | 用户所属公司 |
position | String(Optional) | 用户职位 |
networkConfig | Object(Optional) | 用户网络配置,是否允许外网访问,只有部署开启网络限制开关,该配置才生效 |
ifLeave | Int(Optional) | 用户是否已经离职。1:用户已离职,0:用户未离职 |
attrs | Array(Optional) | 用户权限属性值,见修改用户动态值属性接口中的attrs 参数定义 |
{
"token": "1503575355359c4fdea8ec1683ed10edd91ae",
"users": [{
"email": "zhangsan@163.com",
"phone": 15977765765,
"uniqueId": "20",
"nick": "张三",
"department": "A公司",
"networkConfig": {
"allowExternal": true
},
"ifLeave": 0,
"attrs": [
{
"attrId": 1,
"attrValue": ["东北","华北"]
},
{
"attrId": 2,
"attrValue": ["男"]
},
{
"attrId": 5,
"attrValue": []
},
{
"attrId": 8,
"attrValue": null
}
]
}],
"groupIds": [1,2,3],
"roleNames": ["角色1", "角色2"],
"rolePaths":[
["文件夹1", "文件夹2", "角色A"],
["文件夹3", "文件夹4", "角色B"],
],
"permissionRoleNames": ["行级角色1", "行级角色2"]
}
成功数据返回:
{
"code": 200,
"result": "ok"
}
文档反馈
以上内容对您是否有帮助?