TAS(子)

业务子应用访问租户中心接口

公共分类

说明

基本信息

Path： /readme

Method： GET

接口描述：

# 该服务只能能忘访问

测试环境：
内网地址：http://end-tas-svc.es-iam.svc

测试地址：公网访问
外网地址：http://t1-tenant.dev1.sims-cn.com

正式环境：
内网地址：http://end-tas-svc.rs-iam.svc

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

应用管理

创建当前应用策略（待议）

基本信息

Path： /api/tas/v1/app/priv/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	非必须
name	string	非必须
brief	string	非必须
detail	string	非必须
editable	boolean	非必须
policies	object []	非必须			item 类型: object
├─ id	null	非必须
├─ name	null	非必须
├─ effect	boolean	非必须
├─ actions	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ brief	string	必须
├─ detail	string	必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	string	非必须
name	string	非必须
brief	string	非必须
detail	string	非必须
editable	boolean	非必须
policies	object []	非必须			item 类型: object
├─ id	null	非必须
├─ name	null	非必须
├─ effect	boolean	非必须
├─ actions	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ brief	string	必须
├─ detail	string	必须

创建当前应用角色（待议）

基本信息

Path： /api/tas/v1/app/role/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	非必须
name	string	必须
brief	string	必须
detail	string	非必须
disable	boolean	非必须
editable	boolean	非必须
privs	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ brief	string	必须
├─ detail	string	必须
├─ editable	boolean	必须

删除当前应用策略（待议）

基本信息

Path： /api/tas/v1/app/priv/{pid}/del

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
pid

返回数据

名称	类型	是否必须	默认值	备注	其他信息

删除当前应用角色（待议）

基本信息

Path： /api/tas/v1/app/role/{rid}/del

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
rid

查询租户域应用列表

基本信息

Path： /api/tas/v1/inner/platform/app/for/tenant/

Method： GET

接口描述：

查询 状态 为 1，推荐级别不为 null，且大于 0 的 所有应用。

使用前需要到 【平台应用管理】中，给 应用域所需的相关应用 设置【推荐级别】

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	number	非必须		应用id
├─ code	string	非必须		应用编码
├─ name	string	非必须		名称
├─ avatar	string	非必须		头像
├─ avatarUrl	null	非必须		头像地址
├─ brief	string	非必须		简称
├─ detail	string	非必须		详情
├─ kind	null	非必须
├─ status	string	非必须		状态
├─ indexUri	string	非必须		首页地址
├─ loginUri	string	非必须		登录地址
├─ applyUri	string	非必须		申请使用地址
├─ introUri	string	非必须		介绍说明
├─ tags	null	非必须
├─ recommandedLevel	number	非必须		推荐级别
traceId	string	非必须
total	number	非必须

编辑当前应用策略（待议）

基本信息

Path： /api/tas/v1/app/priv/{pid}/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
pid

Body

名称	类型	是否必须	默认值	备注	其他信息
id	number	非必须
name	string	非必须
brief	string	非必须
detail	string	非必须
editable	boolean	非必须
policies	object []	非必须			item 类型: object
├─ id	number	非必须
├─ name	null	非必须
├─ effect	boolean	非必须
├─ actions	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ brief	string	必须
├─ detail	string	必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息

编辑当前应用角色（待议）

基本信息

Path： /api/tas/v1/app/role/{rid}/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
rid

Body

名称	类型	是否必须	默认值	备注	其他信息
id	number	非必须
name	string	非必须
brief	string	非必须
detail	string	非必须
editable	boolean	非必须
disable	boolean	非必须
privs	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ brief	string	必须
├─ detail	string	必须
├─ editable	boolean	必须

获取当前应用基本配置

基本信息

Path： /api/tas/v1/app/info

Method： GET

接口描述：

请求参数

获取当前应用策略列表（待议）

基本信息

Path： /api/tas/v1/app/privs

Method： GET

接口描述：

请求参数

获取当前应用策略接口（待议）

基本信息

Path： /api/tas/v1/app/priv/actions

Method： GET

接口描述：

请求参数

获取当前应用策略详情（待议）

基本信息

Path： /api/tas/v1/app/priv/{pid}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pid

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取当前应用角色列表（待议）

基本信息

Path： /api/tas/v1/app/roles

Method： GET

接口描述：

请求参数

获取当前应用角色策略（待议）

基本信息

Path： /api/tas/v1/app/role/privs

Method： GET

接口描述：

请求参数

获取当前应用角色详情（待议）

基本信息

Path： /api/tas/v1/app/role/{rid}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
rid

通讯录管理

获取应用通讯录集合（平台管理员用）

基本信息

Path： /api/tas/v1/a/dir/info/app/{aid}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
aid

Query

参数名称	是否必须	示例	备注
hasUser	否	true	是否需要用户。默认值为false
preUser	否	true	用户是否在前边。默认值为false

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取应用通讯录集合（特殊权限）

基本信息

Path： /api/tas/v1/p/dir/info/app/{aid}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
aid	LHDGUAT

Query

参数名称	是否必须	示例	备注
hasUser	否	true	是否需要用户。默认值为false
preUser	否	true	用户是否在前边。默认值为false
tenantCode	是	tCgyv0398z6fczFGLaSKGTS8	租户 code

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取通讯录部门用户（全局）区分部门id

基本信息

Path： /api/tas/v1/a/dir/{did}/users/flat

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
did

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取通讯录部门（平铺）

基本信息

Path： /api/tas/v1/p/dir/info/flat

Method： GET

接口描述：

firstLayer 默认为 false，可不填

请求参数

Query

参数名称	是否必须	示例	备注
firstLayer	否	flase	是否只需要第一层
tenantCode	是	test

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ index	number	必须
├─ parentIndex	number	必须
├─ name	string	必须
traceId	string	非必须
total	number	非必须

获取应用通讯录集合（全局）

基本信息

Path： /api/tas/v1/a/dir/info

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取通讯录部门用户（全局）

基本信息

Path： /api/tas/v1/a/dir/{did}/users

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
did

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取应用通讯录集合（应用用）

基本信息

Path： /api/tas/v1/dir/info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
hasUser	否	true	是否需要用户。默认值为false
preUser	否	true	用户是否在前边。默认值为false
hasCert	否	true	用户是否已认证。默认为null
needAll	否	false	是否包含离职人员。默认为false

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ id	number	非必须
├─ dept	boolean	非必须		是否是部门， true：部门， false: 乘员
├─ code	string	非必须		编码
├─ name	string	非必须		名称
├─ phoneText	string	必须		手机号密钥
├─ phoneShow	string	必须		显示手机号
├─ nodes	object	必须		同当前结构
traceId	string	非必须

获取通讯录部门用户

基本信息

Path： /api/tas/v1/dir/{did}/users

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
did

返回数据

名称	类型	是否必须	默认值	备注	其他信息

编辑部门基本信息

基本信息

Path： /api/tas/v1/dir/{did}/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
did

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	非必须

新建部门基本信息

基本信息

Path： /api/tas/v1/dir/{did}/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
did

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须

删除部门基本信息

基本信息

Path： /api/tas/v1/dir/{did}/del

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
did

编辑部门显示顺序

基本信息

Path： /api/tas/v1/dir/{did}/order/{index}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
did
index

获取部门角色详情

基本信息

Path： /api/tas/v1/dir/{did}/role/edit

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
did

编辑部门角色详情

基本信息

Path： /api/tas/v1/dir/{did}/role/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
did

Body

名称	类型	是否必须	默认值	备注	其他信息
selected	object []	非必须			item 类型: object
├─ role	boolean	必须
├─ rid	number	必须
├─ code	string	必须
├─ name	string	必须
├─ fullName	string	必须
├─ inherit	boolean	必须

数据权限标签管理

批量查询最新配置信息(对外)_备用

基本信息

Path： /api/executor/v1/tag/data/ctx

Method： GET

接口描述：

{
        "success": true,
        "data": [
            {
                "tagCode": "3",
                "dept": [
                    {
                        "id": 43,
                        "pdCode": "27",
                        "pdLevel": 2
                    }
                ],
                "region": [
                    {
                        "id": 11,
                        "pdCode": "ALL",
                        "pdLevel": 0
                    }
                ],
                "cust": [],
                "brand": [
                    {
                        "id": 14,
                        "pdCode": "ALL",
                        "pdLevel": 0
                    }
                ],
                "omer": [
                    {
                        "id": 13,
                        "pdCode": "ALL",
                        "pdLevel": 0
                    }
                ]
            },
            {
                "tagCode": "36",
                "dept": [],
                "region": [
                    {
                        "id": 51,
                        "pdCode": "210211",
                        "pdLevel": 3
                    }
                ],
                "cust": [],
                "brand": [],
                "omer": [
                    {
                        "id": 52,
                        "pdCode": "STCH00BZ3CZFVQBJB7",
                        "pdLevel": 4
                    }
                ]
            }
        ],
        "traceId": "c2868c96cf6782c15f1b60fee56c3ec1"
    }

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
types	否	dept,region,cust,omer,brand	dept:部门 region:区域 cust:客户 omer:渠道 brand:品牌 不填则进行全查,多个类型之间用逗号分隔
tags	是	1,2,3,4	数据标签id,多个id之间用逗号分隔

Body

名称	类型	是否必须	默认值	备注	其他信息
		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		响应状态
data	object []	非必须		响应数据	item 类型: object
├─ tagCode	string	非必须		数据标签id
├─ dept	object []	非必须		部门标签,按查询条件返回，查询不到返回空数组	item 类型: object
├─ id	number	必须		id
├─ pdCode	string	必须		编码
├─ pdLevel	number	必须		层级
├─ region	object []	非必须		区域标签，按查询条件返回，查询不到返回空数组	item 类型: object
├─ id	number	必须		id
├─ pdCode	string	必须		编码
├─ pdLevel	number	必须		层级
├─ cust	object []	非必须		客户标签，按查询条件返回，查询不到返回空数组	item 类型: object
├─ id	number	必须
├─ pdCode	string	必须		编码
├─ pdLevel	number	必须		层级
├─ brand	object []	非必须		品牌标签，按查询条件返回，查询不到返回空数组	item 类型: object
├─ id	number	必须
├─ pdCode	string	必须		编码
├─ pdLevel	number	必须		层级
├─ omer	object []	非必须		渠道标签，按查询条件返回，查询不到返回空数组	item 类型: object
├─ id	number	必须
├─ pdCode	string	必须		编码
├─ pdLevel	number	必须		层级
traceId	string	必须		请求id
errorCode	string	非必须		错误编码
errorMessage	string	非必须		错误信息

获取对象标签（全部）

基本信息

Path： /api/tas/v1/tag/object/{kd}/{cd}/0

Method： GET

接口描述：

直接配置再对象上的标签

请求参数

路径参数

参数名称	示例	备注
kd
cd

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	number	必须
├─ tag	string	必须
├─ parId	number	非必须
traceId	string	非必须
errorCode	string	必须
errorMessage	string	必须

获取对象标签（递归）

基本信息

Path： /api/tas/v1/tag/object/{kd}/{cd}/1

Method： GET

接口描述：

直接配置再对象上的标签，同时展示递归所有的子标签

请求参数

路径参数

参数名称	示例	备注
kd
cd

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	number	必须
├─ tag	string	必须
├─ nodes	object []	非必须			item 类型: object
├─ id	number	非必须
├─ tag	string	非必须
├─ parId	number	非必须
├─ parId	number	非必须
traceId	string	非必须

获取对象标签（集合）

基本信息

Path： /api/tas/v1/tag/object/{kd}/{cd}/2

Method： GET

接口描述：

获取对象上所有的标签，同时平铺所有的子标签

请求参数

路径参数

参数名称	示例	备注
kd
cd

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	number	必须
├─ tag	string	必须
├─ parId	number	非必须
traceId	string	非必须
errorCode	string	非必须
errorMessage	string	非必须

获取当前数据标签

基本信息

Path： /api/tas/v1/tag/user/current

Method： GET

接口描述：

对于平台应用，推荐使用

List<String> tagIds = HeaderUtils.getDataTagsByRequest();
// java 实现内容

    public static List<String> getDataTagsByRequest() {

        String tags = KratosC.getProperty("header.X-Request-Sky-Datatags", String.class);

        return StringUtils.isEmpty(tags) ? Collections.emptyList() : Arrays.asList(tags.split(";"));

    }

来获取标签ID， 尽量不要使用该接口调用获取当前用户标签

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取当前用户所属租户的数据标签

基本信息

Path： /api/tas/v1/tag/tenant/data/all

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取数据标签对象

基本信息

Path： /api/tas/v1/tag/data/{id}/object

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ tagId	number	非必须
├─ tagName	string	非必须
├─ objectKind	string	非必须
├─ objectCode	string	非必须
├─ dept	string	非必须
├─ user	string	非必须
├─ role	string	非必须
traceId	string	非必须
errorCode	string	非必须
errorMessage	string	非必须

获取租户的数据标签

基本信息

Path： /api/tas/v1/inner/tag/tenant/data/all

Method： GET

接口描述：

内部调用

请求参数

Query

参数名称	是否必须	示例	备注
tenantCode	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

租户基础数据管理

批量查询最新配置信息

基本信息

Path： /api/executor/v1/tag/data/ctx

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
tags	是	1	获取配置的标签ID/CODE, 暂时只支持ID,多个标签用逗号分隔
types	否	dept,region,cust,omer,brand	获取配置的类型,多个类型用逗号分隔(dept:部门 region:区域 cust:客户 omer:渠道 brand:品牌),不填则进行全查

Body

名称	类型	是否必须	默认值	备注	其他信息
		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		响应状态
data	object []	非必须		响应数据	item 类型: object
├─ tagCode	string	非必须		标签编码
├─ pdList	object []	非必须		配置信息数组	item 类型: object
├─ pdType	number	非必须		数据维度类型(1:部门 2:区域 3:客户 4:渠道 5:品牌)
├─ dataList	object []	非必须		配置信息详情数组	item 类型: object
├─ id	number	非必须		配置id
├─ pdCode	string	非必须		数据编码
├─ pdLevel	number	非必须		数据层级
traceId	string	必须		请求id
errorCode	string	非必须		错误编码
errorMessage	string	非必须		错误信息
field_22	string	必须

查询用户实名信息，使用租户用户code

基本信息

Path： /api/tas/v1/inner/user/query/by/code

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
tenUserCodes	string []	必须			item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	number	必须
├─ code	string	必须
├─ name	string	必须
├─ isCertification	boolean	必须
├─ caUserCode	null,string	必须
├─ accountCode	string,null	必须
traceId	string	非必须
total	number	非必须

查询用户，使用租户信息

基本信息

Path： /api/tas/v1/inner/user/query/by/tenant

Method： GET

接口描述：

jobStatus 工作状态  0: 未激活， 1: 在职，2: 离职  

请求参数

Query

参数名称	是否必须	示例	备注
tenCode	是	test
size	否
page	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	number	必须
├─ tenUserCode	string	必须		租户用户code
├─ tenCode	string	必须		租户code
├─ email	string,null	必须
├─ gender	string,null	必须
├─ name	string	必须
├─ phoneShow	string,null	必须		电话展示
├─ phoneText	string	必须		电话密文
├─ phoneOrigin	string	必须		电话原文
├─ post	string,null	必须		职位
├─ jobStatus	number	必须		工作状态
├─ depts	object []	必须			item 类型: object
├─ code	string	必须
├─ name	string	必须
traceId	string	非必须
total	number	非必须

查询用户，使用角色信息

基本信息

Path： /api/tas/v1/inner/user/query/by/role

Method： GET

接口描述：

roleCode 和 roleName 必填一个

请求参数

Query

参数名称	是否必须	示例	备注
tenCode	是	test
appId	是	10008	app 的 id
roleName	否	部门角色-继承-02
roleCode	否	rC4Rb08fJ9XCERd2usI9
page	否	0
size	否	20
needAll	否	true	是否返回 全部租户用户（包含离职）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	string	必须
├─ code	string	必须
├─ name	string	必须
├─ nickname	string,null	必须
├─ customCode	string	必须
├─ avatarUri	null	必须
├─ gender	string	必须
├─ email	string	必须
├─ post	null	必须
├─ disable	null	必须
├─ phoneText	string	必须
├─ phoneShow	string	必须
├─ editablePhone	null	必须
├─ confirmCode	null	必须
├─ privilege	string	必须
├─ editablePrivilege	null	必须
├─ editableOwnerShip	null	必须
├─ depts	null	必须
├─ roles	null	必须
├─ tenantName	null	必须
├─ tenantCode	null	必须
traceId	string	非必须
total	number	非必须

查询租户，使用平台应用code

基本信息

Path： /api/tas/v1/inner/tenant/query/by/app

Method： GET

接口描述：

平台应用code 为必填

请求参数

Query

参数名称	是否必须	示例	备注
platformAppCode	是		平台应用code
tenantName	否		租户名称
tenantCode	否		租户code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ code	string	必须
├─ name	string	必须
├─ ownerPhone	string	必须
├─ expiredAt	string	必须
├─ updatedAt	string	必须
traceId	string	非必须
total	number	非必须

查询租户，使用所有者电话

基本信息

Path： /api/tas/v1/tenant/info/list

Method： GET

接口描述：

三个参数，至少有一个有值

请求参数

Query

参数名称	是否必须	示例	备注
tenCode	否	test
tenName	否
phone	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ id	number	必须
├─ code	string	必须
├─ name	string	必须
├─ ownerPhone	string	必须
├─ status	string	必须
traceId	string	非必须
total	number	非必须

查询租户，使用租户 code

基本信息

Path： /api/tas/v1/inner/tenant/query/by/code

Method： GET

接口描述：

租户 code 为必填

请求参数

Query

参数名称	是否必须	示例	备注
tenantCode	否		租户code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ code	string	必须
├─ name	string	必须
├─ ownerPhone	string	必须
├─ expiredAt	string	必须
├─ updatedAt	string	必须
traceId	string	非必须
total	number	非必须

查询租户，使用账户 code

基本信息

Path： /api/tas/v1/inner/tenant/query/by/account

Method： GET

接口描述：

账户 code 为必填。返回的租户为 账户所相关的租户，且 账户 在租户中为 管理员或所有者

请求参数

Query

参数名称	是否必须	示例	备注
accountCode	否		账户code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ tenants	object []	非必须		租户信息	item 类型: object
├─ code	string	必须
├─ name	string	必须
├─ accountPrivilege	string	必须
├─ accountInfo	object	非必须		账户信息
├─ code	string	非必须
├─ name	string	非必须
traceId	string	非必须

模糊查询用户，在应用的通讯录范围内

基本信息

Path： /api/tas/v1/inner/user/query/by/name

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
tenCode	是	tCZFb0KALtBGgjW4FtGT99Ep
appCode	是	lhdg2
nameOrCode	是	东	通讯录姓名或者ccde

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取标签对应的数据集合

基本信息

Path： /api/tas/v1/tag/data/ctx

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
types	是	dept,brand,region,customer	获取配置的类型
tags	是	1,2,3,4	获取配置的标签ID/CODE, 暂时只支持ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ dept	object	非必须
├─ region	object	非必须
├─ customer	object	非必须

租户用户管理

上传用户头像（待议）

基本信息

Path： /api/tas/v1/user/avatar

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是

创建租户用户（待议）

基本信息

Path： /api/tas/v1/user/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
avatar	string	非必须
avatarUri	string	非必须
code	string	非必须
customCode	string	必须
depts	string []	非必须			item 类型: string
├─		非必须
editableOwnerShip	boolean	非必须
editablePhone	boolean	非必须
editablePrivilege	boolean	非必须
email	string	非必须
gender	string	非必须
id	string	非必须
name	string	必须
nickname	string	非必须
phoneText	string	必须
post	string	非必须
privilege	string	非必须
roles	string []	非必须			item 类型: string
├─		非必须

删除租户用户（待议）

基本信息

Path： /api/tas/v1/user/u{uid}/del

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
uid

批量创建租户用户及部门

基本信息

Path： /api/tas/v1/pub/user/generator

Method： POST

接口描述：

【接口需要登录权限】

批量导入时，部门不重复创建

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
dirNodes	object []	非必须		待新增的部门	item 类型: object
├─ parentIndex	number	必须		父节点 index（code）
├─ name	string	必须		节点名称
tenantCode	string	必须		租户code
phoneType	string	必须		电话类别，kms 或者 origin
tenUsers	object []	非必须		待导入的租户用户	item 类型: object
├─ staffId	number	非必须		员工id
├─ name	string	非必须
├─ nickname	string	非必须
├─ customCode	string	非必须
├─ gender	string	非必须
├─ email	string	非必须
├─ phoneText	string	非必须
├─ privilege	string	非必须
├─ depts	object []	非必须		员工的部门（可以为多个）	item 类型: object
├─ index	number	非必须		部门的index，如果是本次新增的部门，则必须为null
├─ name	string	非必须		部门名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object []	非必须			item 类型: object
├─ success	boolean	非必须		本租户用户是否导入成功
├─ tenUserCode	string	非必须		租户用户code
├─ staffId	number	非必须
├─ message	string	非必须		信息
traceId	string	非必须
total	number	非必须

批量删除用户（待议）(未测试)

基本信息

Path： /api/tas/v1/user/del/all

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

编辑用户详情（待议）

基本信息

Path： /api/tas/v1/user/u{uid}/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
uid

Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	非必须
code	string	非必须
name	string	非必须
nickname	string	非必须
customCode	string	非必须
avatarUri	null	非必须
gender	string	非必须
email	string	非必须
post	string	非必须
disable	null	非必须
phoneText	string	非必须
editablePhone	boolean	非必须
confirmCode	null	非必须
privilege	string	非必须
editablePrivilege	boolean	非必须
editableOwnerShip	null	非必须
depts	string []	非必须			item 类型: string
├─		非必须
roles	string []	非必须			item 类型: string
├─		非必须
tenantName	null	非必须
tenantCode	null	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取用户角色-内部使用

基本信息

Path： /api/tas/v1/inner/user/u{uid}/roles

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
uid

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取用户角色（待议）

基本信息

Path： /api/tas/v1/user/u{uid}/roles

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
uid

获取用户详情

基本信息

Path： /api/tas/v1/user/u{uid}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
uid

获取用户部门

基本信息

Path： /api/tas/v1/user/u{uid}/dir

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
uid

获取用户部门（code）应用内使用 code

基本信息

Path： /api/tas/v1/user/code/{code}/dir

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ code	string	非必须
├─ name	string	非必须
├─ nodes	object []	非必须			item 类型: object
├─ dept	boolean	必须
├─ code	string	必须
├─ name	string	必须
├─ nodes	object []	必须			item 类型: object
├─ dept	boolean	必须
├─ code	string	必须
├─ name	string	必须
├─ nodes	object []	非必须			item 类型: object
traceId	string	非必须

获取用户部门（code）应用内使用 customerCode

基本信息

Path： /api/tas/v1/user/ccde/{code}/dir

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ code	string	非必须
├─ name	string	非必须
├─ nodes	object []	非必须			item 类型: object
├─ dept	boolean	必须
├─ code	string	必须
├─ name	string	必须
├─ nodes	object []	必须			item 类型: object
├─ dept	boolean	必须
├─ code	string	必须
├─ name	string	必须
├─ nodes	object []	非必须			item 类型: object
traceId	string	非必须

获取用户部门（code）租户在平台用

基本信息

Path： /api/tas/v1/for/mng/user/ccde/{code}/dir

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ code	string	非必须
├─ name	string	非必须
├─ nodes	object []	非必须			item 类型: object
├─ dept	boolean	必须
├─ code	string	必须
├─ name	string	必须
├─ nodes	object []	必须			item 类型: object
├─ dept	boolean	必须
├─ code	string	必须
├─ name	string	必须
├─ nodes	object []	非必须			item 类型: object
traceId	string	非必须

配置用户状态（待议）

基本信息

Path： /api/tas/v1/user/u{uid}/status/{flag}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
uid
flag

总线列表

保存配置信息

基本信息

Path： /modify

Method： GET

接口描述：

hash值:标签编码tagCode、过期时间expiredAt及按照变更时间排序的已选权限数据pdCode集合, 通过MD5+SHA-1加密算法得到
总线主题：com.myfmes.tas.tag.data.conf.modify

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

全局标签修改

基本信息

Path： /com.myfmes.tas.tag.data.modify

Method： GET

接口描述：

3个hash值

修改通讯录导致标签hash变更
修改人员导致标签hash变更
修改标签内容导致标签内容变更

总线主题： com.myfmes.tas.tag.data.modify
内容：

@Getter @Setter
@JsonIgnoreProperties(ignoreUnknown = true)
public class DataTagModifySO {
    private String sid;     // session id
    private String traceId; // trace id
private String kind; // user|dept
private String code; // object[|dept]|role

private String dept; // 部门，index
private String user; // 用户, 编码
private String role; // 角色, 编码

private Integer tenantId;   // 租户ID
private String  tenantCode; // 租户编码
private String  tenantName; // 租户名称

private String hashAllTags;     // 全部标签hash
private List<DataTagSO> tags;   // 受影响的标签
// kind=dept时
private String hashAllUsers;    // 全部用户hash
private List<DataUserSO> users; // 受影响的标签

private String  updater;    // 更新人
private Integer version;    // 版本号

@Getter @Setter
@JsonIgnoreProperties(ignoreUnknown = true)
public static class DataTagSO {
    private Integer tagId;    // 标签ID
    private String  tagName;  // 标签名称
    private String  hashConf; // hash配置
    private String  status;   // create|update|delete
}

@Getter @Setter
@JsonIgnoreProperties(ignoreUnknown = true)
public static class DataUserSO {
    private Integer userId;   // 用户ID
    private String  userCode; // 用户编码
    private String  userName; // 用户名称
    private String  status;   // create|update|delete
}

// role: 所有的role code都使用"r"开头
// 用户角色, [role code]
// 部门角色, [department code][role code]
// 继承角色, [0][department code][role code]

}

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

标签内容修改

基本信息

Path： /-tag-change

Method： GET

接口描述：

标签code，hash值，租户编码，sid，expiredAt过期时间(为空则永久有效)

hash值：通过MD5+SHA-1得到

请求参数