作者 ivy

背景

一、产品概述

1.版本信息

  • 软件版本号：v2.10.1

2.文档历史

时间 版本号 编写人 主要内容
2021-09-29 v2.10.1 ivy 新建

二、文档说明

1、名词解释

术语 / 缩略词 说明

三、接口说明

部门同步接口

POST http://{{host}}:{{port}}/ips/sync/dept?tenantCode=xxx

参数名称 参数类型 说明 数据类型 长度 必填
tenantCode query 租户编码 字符串 50 是
RequestBody body 部门树 JSON
是

POST RequestBody

字段名称 说明 数据类型 长度 必填
name 部门名称 字符串 100 是
hasChildren 是否有下级部门 布尔值
是
children 下级部门节点 数组
是
parentName 上级部门名称 字符串
是

RequestBody示例：

  1. {
  2.     "hasChildren": true,
  3.     "name": "安睿智达（成都）科技有限公司",
  4.     "children": [
  5.         {
  6.             "hasChildren": false,
  7.             "name": "人力资源部",
  8.             "parentName": "安睿智达（成都）科技有限公司",
  9.             "children": []
  10.         },
  11.         {
  12.             "hasChildren": false,
  13.             "parentName": "安睿智达（成都）科技有限公司",
  14.             "name": "研发中心",
  15.             "children": [],
  16.         },
  17.         {
  18.             "hasChildren": false,
  19.             "parentName": "安睿智达（成都）科技有限公司",
  20.             "name": "销售部",
  21.             "children": []
  22.         }
  23.     ]
  24. }

角色同步接口

POST http://{{host}}:{{port}}/ips/sync/role?tenantCode=xxx

参数名称 参数类型 说明 数据类型 长度 必填
tenantCode query 租户编码 字符串 50 是
RequestBody body 部门树 JSON
是

POST RequestBody

字段名称 说明 数据类型 长度 必填
roleName 角色名称 字符串 100 是
roleCode 角色编码 字符串 100 是
roleDesc 角色描述 字符串 200 否

RequestBody示例：

  1. [
  2.     {
  3.         "roleName": "大区经理",
  4.         "roleCode": "xxx_manager_role",
  5.         "roleDesc": "xxx大区经理"
  6.     }
  7. ]

用户同步接口

POST http://{{host}}:{{port}}/ips/sync/user?tenantCode=xxx

参数名称 参数类型 说明 数据类型 长度 必填
tenantCode query 租户编码 字符串 50 是
RequestBody body 部门树 JSON
是

POST RequestBody

字段名称 说明 数据类型 长度 必填
username 登陆名 字符串 100 是
name 用户姓名 字符串 200 是
password 密码 字符串 16 否
deptName 部门名称 字符串 100 是
roles 用户角色，如果该字段为空系统将给该用户设置固定的角色 数组
否

RequestBody示例：

  1. [
  2.     {
  3.         "username": "alaobe",
  4.         "name": "埃莱奥比",
  5.         "password": "SW#^UGFDW#^",
  6.         "deptName": "研发中心",
  7.         "roles": []
  8.     },
  9.     {
  10.         "username": "bolt",
  11.         "name": "博尔特",
  12.         "password": "MG#$%IKJGF",
  13.         "deptName": "研发中心",
  14.         "roles": []
  15.     }
  16. ]

四、功能说明

1.单点登陆流程图

服务单点登陆说明 - 图1