API文档
# AIDM单点登录认证系统API文档
简介:AIDM单点登录认证系统API文档
HOST:localhost:9527
联系人:apusic.com
Version:v0.1.0 GA
接口路径:/v2/api-docs
[TOC]
# 1-01-1-用户接口文档模块
# 查询用户列表接口
接口地址:/api/apusic/v1.0/userinfo
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询用户列表地址(无离职人员,查询所有用户,这里传入status,username即可)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| containsChildren | 是否包含下级用户（1为包含，0为不包含） | query | false | string | |
| expireStatus | 是否过期(1为过期,0为未过期) | query | false | integer(int32) | |
| isLocked | 是否锁定(1为锁定,0为未锁定) | query | false | integer(int32) | |
| org | 单个组织节点 | query | false | string | |
| status | 状态（1启用 2停用 3过期 4离职） | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string | |
| username | 用户名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 新增用户信息接口
接口地址:/api/apusic/v1.0/userinfo
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---新增用户信息地址
请求示例:
{
"appIdList": [],
"displayName": "张三",
"email": "89465156@qq.com",
"expireTime": "2029-09-09 10:00:00",
"extendAttrDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"managerType": 0,
"mobile": 15607164562,
"orgIdList": [],
"password": "as_Bs124",
"picture": "",
"rolesIdList": [],
"status": 1,
"tenantId": 0,
"username": "admin"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| user | 创建用户请求类 | body | true | UserInfoCreateRequest | UserInfoCreateRequest |
| appIdList | APPid集合 | false | array | string | |
| displayName | 用户中文名称 | false | string | ||
| 邮箱 | false | string | |||
| expireTime | 过期时间 | false | string | ||
| extendAttrDataList | 扩展字段集合 | false | array | UserinfoExtendAttr2Data对象 | |
| checks | false | array | EnumVO | ||
| id | false | string | |||
| name | false | string | |||
| value | false | string | |||
| createBy | 创建人 | false | string | ||
| createTime | 创建时间 | false | string | ||
| dataType | false | string | |||
| description | false | string | |||
| extendAttrData | false | string | |||
| extendAttrKey | false | string | |||
| extendAttrName | false | string | |||
| extendId | false | string | |||
| isEdit | false | integer | |||
| isNull | false | integer | |||
| isUnique | false | integer | |||
| isVisible | false | integer | |||
| sortIndex | false | integer | |||
| tenantId | 租户 | false | string | ||
| updateBy | 修改人 | false | string | ||
| updateTime | 修改时间 | false | string | ||
| managerType | 是否为管理员（0为否，1为是） | false | integer(int32) | ||
| mobile | 手机号 | false | string | ||
| orgIdList | 组织列表id集合(迭代1写死 1 即可) | false | array | string | |
| password | 密码 | false | string | ||
| picture | 照片 | false | string | ||
| rolesIdList | 角色id集合 | false | array | string | |
| status | 状态 | false | integer(int32) | ||
| tenantId | 租户 | false | string | ||
| username | 用户名 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 查询用户列表接口
接口地址:/api/apusic/v1.0/userinfo/all
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询分组下用户列表地址(无离职人员,这里传入username,没有手机号的模糊查询)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| tenantId | 租户 | query | false | string | |
| username | 用户名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 查询离职用户列表接口
接口地址:/api/apusic/v1.0/userinfo/dimission
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询离职用户列表地址(如需必要只需要传入username)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| containsChildren | 是否包含下级用户（1为包含，0为不包含） | query | false | string | |
| expireStatus | 是否过期(1为过期,0为未过期) | query | false | integer(int32) | |
| isLocked | 是否锁定(1为锁定,0为未锁定) | query | false | integer(int32) | |
| org | 单个组织节点 | query | false | string | |
| status | 状态（1启用 2停用 3过期 4离职） | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string | |
| username | 用户名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 查询套餐接口
接口地址:/api/apusic/v1.0/userinfo/license
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询套餐
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 用户解锁账号接口
接口地址:/api/apusic/v1.0/userinfo/locked/{id}/{lockedStatus}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---用户解锁账号信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| lockedStatus | lockedStatus | path | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 查询某组织节点下的用户列表接口
接口地址:/api/apusic/v1.0/userinfo/org
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询某组织节点下的用户列表接口(无离职人员),只需要传组织节点和username
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| containsChildren | 是否包含下级用户（1为包含，0为不包含） | query | false | string | |
| expireStatus | 是否过期(1为过期,0为未过期) | query | false | integer(int32) | |
| isLocked | 是否锁定(1为锁定,0为未锁定) | query | false | integer(int32) | |
| org | 单个组织节点 | query | false | string | |
| status | 状态（1启用 2停用 3过期 4离职） | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string | |
| username | 用户名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 查询组织下未选中用户接口
接口地址:/api/apusic/v1.0/userinfo/org/unuser
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询组织下未选中用户接口（id为组织主键id）
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| containsChildren | 是否包含下级用户（1为包含，0为不包含） | query | false | string | |
| expireStatus | 是否过期(1为过期,0为未过期) | query | false | integer(int32) | |
| isLocked | 是否锁定(1为锁定,0为未锁定) | query | false | integer(int32) | |
| org | 单个组织节点 | query | false | string | |
| status | 状态（1启用 2停用 3过期 4离职） | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string | |
| username | 用户名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 复职用户信息接口
接口地址:/api/apusic/v1.0/userinfo/resume/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---复职用户信息地址
请求示例:
[]
1
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| orgIdList | orgIdList | body | true | array | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 用户重置密码
接口地址:/api/apusic/v1.0/userinfo/user/password/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---用户重置随机密码(id为用户主键id)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 批量离职用户信息接口
接口地址:/api/apusic/v1.0/userinfo/users/status
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---批量离职用户信息地址,传入用户主键集合（userIds）和状态（status）即可
请求示例:
{
"displayName": "张三",
"email": "89465156@qq.com",
"expireStatus": 1,
"expireTime": "2029-09-09 10:00:00",
"gender": 1,
"mobile": 15607164562,
"picture": "",
"status": 1,
"tenantId": 0,
"userIds": []
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 用户信息修改实体类 | body | true | UserInfoEditRequest | UserInfoEditRequest |
| displayName | 用户中文名称 | false | string | ||
| 邮箱 | false | string | |||
| expireStatus | 过期状态 | false | integer(int32) | ||
| expireTime | 过期时间 | false | string | ||
| gender | 性别（0 :未知的性别 1 : 男性 2 :女性 9 :未说明的性别） | false | integer(int32) | ||
| mobile | 手机号 | false | string | ||
| picture | 照片 | false | string | ||
| status | 状态 | false | integer(int32) | ||
| tenantId | 租户 | false | string | ||
| userIds | 用户主键集合 | false | array | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 新增用户信息校验接口
接口地址:/api/apusic/v1.0/userinfo/valid/user
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---新增用户信息校验地址
请求示例:
{
"appIdList": [],
"displayName": "张三",
"email": "89465156@qq.com",
"expireTime": "2029-09-09 10:00:00",
"extendAttrDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"managerType": 0,
"mobile": 15607164562,
"orgIdList": [],
"password": "as_Bs124",
"picture": "",
"rolesIdList": [],
"status": 1,
"tenantId": 0,
"username": "admin"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| user | 创建用户请求类 | body | true | UserInfoCreateRequest | UserInfoCreateRequest |
| appIdList | APPid集合 | false | array | string | |
| displayName | 用户中文名称 | false | string | ||
| 邮箱 | false | string | |||
| expireTime | 过期时间 | false | string | ||
| extendAttrDataList | 扩展字段集合 | false | array | UserinfoExtendAttr2Data对象 | |
| checks | false | array | EnumVO | ||
| id | false | string | |||
| name | false | string | |||
| value | false | string | |||
| createBy | 创建人 | false | string | ||
| createTime | 创建时间 | false | string | ||
| dataType | false | string | |||
| description | false | string | |||
| extendAttrData | false | string | |||
| extendAttrKey | false | string | |||
| extendAttrName | false | string | |||
| extendId | false | string | |||
| isEdit | false | integer | |||
| isNull | false | integer | |||
| isUnique | false | integer | |||
| isVisible | false | integer | |||
| sortIndex | false | integer | |||
| tenantId | 租户 | false | string | ||
| updateBy | 修改人 | false | string | ||
| updateTime | 修改时间 | false | string | ||
| managerType | 是否为管理员（0为否，1为是） | false | integer(int32) | ||
| mobile | 手机号 | false | string | ||
| orgIdList | 组织列表id集合(迭代1写死 1 即可) | false | array | string | |
| password | 密码 | false | string | ||
| picture | 照片 | false | string | ||
| rolesIdList | 角色id集合 | false | array | string | |
| status | 状态 | false | integer(int32) | ||
| tenantId | 租户 | false | string | ||
| username | 用户名 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 查询单个用户信息
接口地址:/api/apusic/v1.0/userinfo/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询单个用户信息(id为用户主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 修改用户信息接口
接口地址:/api/apusic/v1.0/userinfo/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改用户信息地址
请求示例:
{
"displayName": "张三",
"email": "89465156@qq.com",
"expireStatus": 1,
"expireTime": "2029-09-09 10:00:00",
"gender": 1,
"mobile": 15607164562,
"picture": "",
"status": 1,
"tenantId": 0,
"userIds": []
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| userInfo | 用户信息修改实体类 | body | true | UserInfoEditRequest | UserInfoEditRequest |
| displayName | 用户中文名称 | false | string | ||
| 邮箱 | false | string | |||
| expireStatus | 过期状态 | false | integer(int32) | ||
| expireTime | 过期时间 | false | string | ||
| gender | 性别（0 :未知的性别 1 : 男性 2 :女性 9 :未说明的性别） | false | integer(int32) | ||
| mobile | 手机号 | false | string | ||
| picture | 照片 | false | string | ||
| status | 状态 | false | integer(int32) | ||
| tenantId | 租户 | false | string | ||
| userIds | 用户主键集合 | false | array | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 修改用户状态信息接口
接口地址:/api/apusic/v1.0/userinfo/{id}/{status}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改用户状态信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| status | status | path | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 1-01-2-个人中心接口文档模块
# 绑定邮件接口
接口地址:/api/apusic/v1.0/personal/email/valid/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---绑定邮件信息地址(需要传入id,email,templateStatus,validCode),
请求示例:
{
"email": "zhangsan@apusic.net",
"templateStatus": 0,
"validCode": 434524
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 用户信息邮箱实体类(个人中心) | body | true | PersonalEmailRequest | PersonalEmailRequest |
| 邮箱 | false | string | |||
| templateStatus | 绑定/解绑(1为绑定,0为解绑) | false | integer(int32) | ||
| validCode | 邮箱验证码 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 发送邮件接口
接口地址:/api/apusic/v1.0/personal/email/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---发送邮件信息地址(只需要传入id和email,templateStatus)
请求示例:
{
"email": "zhangsan@apusic.net",
"templateStatus": 0,
"validCode": 434524
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 用户信息邮箱实体类(个人中心) | body | true | PersonalEmailRequest | PersonalEmailRequest |
| 邮箱 | false | string | |||
| templateStatus | 绑定/解绑(1为绑定,0为解绑) | false | integer(int32) | ||
| validCode | 邮箱验证码 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 查询用户头像
接口地址:/api/apusic/v1.0/personal/getphoto/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
李春阳---查询用户头像地址(id为用户主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Map«string,string»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 用户首次登录修改密码接口
接口地址:/api/apusic/v1.0/personal/initial/password/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---用户首次登录修改密码信息地址
请求示例:
{
"password": "1233Aa"
}
1
2
3
2
3
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| personalPasswordEditRequest | 用户首次登录强制修改密码实体类 | body | true | PersonalPasswordEditRequest | PersonalPasswordEditRequest |
| password | 密码 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 修改用户密码接口
接口地址:/api/apusic/v1.0/personal/password/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改用户密码信息地址(只需要传入用户名密码和id)
请求示例:
{
"currentPassword": "123Aa!",
"displayName": "张三",
"extendAttrs": [
{
"extendAttrData": "",
"extendId": ""
}
],
"gender": 1,
"newPassword": "123Aa!"
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| personalEditRequest | 用户信息修改实体类(个人中心) | body | true | PersonalEditRequest | PersonalEditRequest |
| currentPassword | 当前密码 | false | string | ||
| displayName | 用户中文名称 | false | string | ||
| extendAttrs | 用户扩展字段集合 | false | array | UserExtendAttrDataUpdateRequest | |
| extendAttrData | false | string | |||
| extendId | false | string | |||
| gender | 性别（0 :未知的性别 1 : 男性 2 :女性 9 :未说明的性别） | false | integer(int32) | ||
| newPassword | 新密码 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 修改用户头像接口
接口地址:/api/apusic/v1.0/personal/picture/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改用户头像地址
请求示例:
{
"picture": "aidm/picture/111.gif"
}
1
2
3
2
3
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| userInfo | 用户头像修改实体类 | body | true | PersonalPictureEditRequest | PersonalPictureEditRequest |
| picture | 用户头像文件路径 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 绑定手机号接口
接口地址:/api/apusic/v1.0/personal/sms/valid/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---绑定手机号信息地址(需要传入id,mobile,validCode,templateStatus)
请求示例:
{
"mobile": 15607165455,
"templateStatus": 1,
"validCode": 434524
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 用户信息手机号实体类(个人中心) | body | true | PersonalSmsRequest | PersonalSmsRequest |
| mobile | 手机号 | false | string | ||
| templateStatus | 解绑/绑定 | false | integer(int32) | ||
| validCode | 手机验证码 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 发送手机验证码接口
接口地址:/api/apusic/v1.0/personal/sms/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---发送手机验证码(解绑和绑定)信息地址(只需要传入id,templateStatus和mobile)
请求示例:
{
"mobile": 15607165455,
"templateStatus": 1,
"validCode": 434524
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 用户信息手机号实体类(个人中心) | body | true | PersonalSmsRequest | PersonalSmsRequest |
| mobile | 手机号 | false | string | ||
| templateStatus | 解绑/绑定 | false | integer(int32) | ||
| validCode | 手机验证码 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询单个用户信息
接口地址:/api/apusic/v1.0/personal/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询单个用户信息(id为用户主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«PersonalVO对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | PersonalVO对象 | PersonalVO对象 |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名 | string | |
| 邮箱 | string | ||
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| id | 用户主键 | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| mobile | 手机号 | string | |
| orgList | 用户所属组织集合 | array | Organizations |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| picture | 照片 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "",
"gender": 1,
"id": 622227747934179401,
"lastLoginTime": "2021-11-02 09:56:34",
"managerType": 1,
"mobile": "",
"orgList": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"picture": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# 修改用户信息接口
接口地址:/api/apusic/v1.0/personal/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改用户信息地址(只需要传入姓名性别和id)
请求示例:
{
"currentPassword": "123Aa!",
"displayName": "张三",
"extendAttrs": [
{
"extendAttrData": "",
"extendId": ""
}
],
"gender": 1,
"newPassword": "123Aa!"
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| userInfo | 用户信息修改实体类(个人中心) | body | true | PersonalEditRequest | PersonalEditRequest |
| currentPassword | 当前密码 | false | string | ||
| displayName | 用户中文名称 | false | string | ||
| extendAttrs | 用户扩展字段集合 | false | array | UserExtendAttrDataUpdateRequest | |
| extendAttrData | false | string | |||
| extendId | false | string | |||
| gender | 性别（0 :未知的性别 1 : 男性 2 :女性 9 :未说明的性别） | false | integer(int32) | ||
| newPassword | 新密码 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserInfo对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserInfo对象 | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 1-01-3-企业门户接口文档模块
# 应用登录次数前5排名
接口地址:/api/apusic/v1.0/enterprise/applogincount
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---应用登录次数前5排名
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«HistoryLoginAppsCount»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | HistoryLoginAppsCount |
| appId | string | ||
| appName | string | ||
| createBy | string | ||
| createTime | string(date-time) | ||
| date | string(date-time) | ||
| id | string | ||
| loginCount | integer(int32) | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string(date-time) | ||
| userId | string | ||
| userName | string | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appId": "",
"appName": "",
"createBy": "",
"createTime": "",
"date": "",
"id": "",
"loginCount": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userName": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# 应用总数
接口地址:/api/apusic/v1.0/enterprise/appsum
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---应用总数地址
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 最近登录
接口地址:/api/apusic/v1.0/enterprise/latestlogin
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---最新登录的五个未离职用户(按照最后登录时间倒序排列)
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfoVO对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfoVO对象 |
| createTime | 用户注册时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| lastLoginTime | 用户末次登录时间 | string(date-time) | |
| loginCount | 登录次数 | integer(int32) | |
| picture | 头像 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"createTime": "2021-11-02 09:56:34",
"displayName": "张三",
"lastLoginTime": "2021-11-02 09:56:34",
"loginCount": 132,
"picture": "",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 用户登陆次数
接口地址:/api/apusic/v1.0/enterprise/maxlogin
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---录次数最多的5个未离职用户(按照最后登录时间倒序排列)
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfoVO对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfoVO对象 |
| createTime | 用户注册时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| lastLoginTime | 用户末次登录时间 | string(date-time) | |
| loginCount | 登录次数 | integer(int32) | |
| picture | 头像 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"createTime": "2021-11-02 09:56:34",
"displayName": "张三",
"lastLoginTime": "2021-11-02 09:56:34",
"loginCount": 132,
"picture": "",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 7日新增用户
接口地址:/api/apusic/v1.0/enterprise/sevendayinsert
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---7日新增用户
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 前7周新增用户
接口地址:/api/apusic/v1.0/enterprise/sevenweekinsert
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---前7周新增用户
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 前7周登录用户
接口地址:/api/apusic/v1.0/enterprise/sevenweeklogin
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---前7周登录用户
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 今日新增用户-环比
接口地址:/api/apusic/v1.0/enterprise/todayinsert
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---今日新增用户/环比
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 用户总数趋势
接口地址:/api/apusic/v1.0/enterprise/usercount
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---用户总数趋势(传入用户总数趋势图中的开始时间startTime,结束时间endTime)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| endTime | 结束时间 | query | false | string | |
| month | 用户热点图月份 | query | false | string | |
| startTime | 开始时间 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 一个月用户登录热点图
接口地址:/api/apusic/v1.0/enterprise/userlogin
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---一个月用户登录热点图(传入一个月用户热点图图中的月份month)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| endTime | 结束时间 | query | false | string | |
| month | 用户热点图月份 | query | false | string | |
| startTime | 开始时间 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 用户总数
接口地址:/api/apusic/v1.0/enterprise/usersum
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---用户总数地址
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 本周新增用户-环比
接口地址:/api/apusic/v1.0/enterprise/weekinsert
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---本周新增用户/环比
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 本周登录用户-环比上周
接口地址:/api/apusic/v1.0/enterprise/weeklogin
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---本周登录用户/环比上周
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-01-4-用户门户接口文档模块
# 用户常用应用
接口地址:/api/apusic/v1.0/userportal/app/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---用户常用应用(传入id用户主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 某月登录热点图
接口地址:/api/apusic/v1.0/userportal/loginwave
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---登录热点图(传入id用户主键,月份month)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | 用户id | query | false | string | |
| month | 登录热点图月份 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 最新动态
接口地址:/api/apusic/v1.0/userportal/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---最新动态(传入id用户主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-01-5-用户导入文档模块
# 用户错误信息下载
接口地址:/api/apusic/v1.0/userInfoImport/excel/error/{uuid}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---用户错误信息下载
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| uuid | uuid | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# excel导入用户
接口地址:/api/apusic/v1.0/userInfoImport/excel/read
请求方式:POST
请求数据类型:multipart/form-data
响应数据类型:application/json
接口描述:
赵禹---excel导入用户
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| file | file | body | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 用户导入模板
接口地址:/api/apusic/v1.0/userInfoImport/excel/template
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---用户导入模板
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-01-6-用户拓展字段文档模块
# 查询用户拓展字段接口(分页)
接口地址:/api/apusic/v1.0/userinfo_extend
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查询用户拓展字段
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 添加用户扩展字段接口
接口地址:/api/apusic/v1.0/userinfo_extend
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
李春阳---添加用户扩展字段
请求示例:
{
"dataType": "",
"description": "",
"enums": [
{
"id": "",
"name": "",
"value": ""
}
],
"extendAttrKey": "",
"extendAttrName": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | request | body | true | UserinfoExtendAttrCreateRequest | UserinfoExtendAttrCreateRequest |
| dataType | false | string | |||
| description | false | string | |||
| enums | false | array | EnumVO | ||
| id | false | string | |||
| name | false | string | |||
| value | false | string | |||
| extendAttrKey | false | string | |||
| extendAttrName | false | string | |||
| isEdit | false | integer(int32) | |||
| isNull | false | integer(int32) | |||
| isUnique | false | integer(int32) | |||
| isVisible | false | integer(int32) | |||
| sortIndex | false | integer(int32) | |||
| tenantId | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 根据id查询扩展字段信息接口
接口地址:/api/apusic/v1.0/userinfo_extend/showattr/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
李春阳---根据id查询扩展字段信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserinfoExtendAttr对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserinfoExtendAttr对象 | UserinfoExtendAttr对象 |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| dataType | string | ||
| description | string | ||
| enums | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| id | string | ||
| isEdit | integer(int32) | ||
| isNull | integer(int32) | ||
| isUnique | integer(int32) | ||
| isVisible | integer(int32) | ||
| sortIndex | integer(int32) | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"enums": [
{
"id": "",
"name": "",
"value": ""
}
],
"extendAttrKey": "",
"extendAttrName": "",
"id": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# 展示用户扩展字段(名称: 值)接口
接口地址:/api/apusic/v1.0/userinfo_extend/showdata/{userinfo_id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
李春阳---展示用户扩展字段(名称: 值)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| userinfo_id | userinfo_id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserinfoExtendAttr2Data对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer(int32) | ||
| isNull | integer(int32) | ||
| isUnique | integer(int32) | ||
| isVisible | integer(int32) | ||
| sortIndex | integer(int32) | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# 修改用户扩展字段值接口
接口地址:/api/apusic/v1.0/userinfo_extend/updateattrdata/{userinfoId}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
李春阳---修改用户扩展字段值
请求示例:
[
{
"extendAttrData": "",
"extendId": ""
}
]
1
2
3
4
5
6
2
3
4
5
6
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | request | body | true | array | UserExtendAttrDataUpdateRequest |
| extendAttrData | false | string | |||
| extendId | false | string | |||
| userinfoId | userinfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 修改用户扩展字段接口
接口地址:/api/apusic/v1.0/userinfo_extend/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
李春阳---修改用户扩展字段
请求示例:
{
"description": "",
"enums": [
{
"id": "",
"name": "",
"value": ""
}
],
"extendAttrName": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"removeEnums": [],
"sortIndex": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | request | body | true | UserinfoExtendAttrEditRequest | UserinfoExtendAttrEditRequest |
| description | false | string | |||
| enums | false | array | EnumVO | ||
| id | false | string | |||
| name | false | string | |||
| value | false | string | |||
| extendAttrName | false | string | |||
| isEdit | false | integer(int32) | |||
| isNull | false | integer(int32) | |||
| isUnique | false | integer(int32) | |||
| isVisible | false | integer(int32) | |||
| removeEnums | false | array | string | ||
| sortIndex | false | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除用户扩展字段接口
接口地址:/api/apusic/v1.0/userinfo_extend/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
李春阳---删除用户扩展字段接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-01-7-用户接口文档模块(Map)
# 查询单个用户信息
接口地址:/api/apusic/v1.0/userinfoMap/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
李春阳---查询单个用户信息(id为用户主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Map«string,object»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-01-8-用户信息返回配置文档模块
# 新增返回配置信息
接口地址:/api/apusic/v1.0/userinforesponseconfig
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
李春阳---新增某租户下返回配置信息
请求示例:
{
"actualName": "",
"extend": 0,
"responseName": "",
"tenantId": ""
}
1
2
3
4
5
6
2
3
4
5
6
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 创建返回配置信息请求 | body | true | ResponseConfigCreateRequest | ResponseConfigCreateRequest |
| actualName | 类中或表中名称 | false | string | ||
| extend | 是否为扩展字段 | false | integer(int32) | ||
| responseName | 返回给前端的名称 | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserinfoResponseConfig对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserinfoResponseConfig对象 | UserinfoResponseConfig对象 |
| actualName | 类中或表中名称 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| extend | 是否为扩展字段 | integer(int32) | |
| id | 配置主键 | string | |
| responseName | 返回给前端的名称 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"actualName": "",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"extend": 0,
"id": "",
"responseName": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 修改返回配置信息
接口地址:/api/apusic/v1.0/userinforesponseconfig/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
李春阳---修改已配置的信息
请求示例:
{
"actualName": "",
"extend": 0,
"responseName": ""
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 用户信息配置返回实体类 | body | true | UserinfoResponseConfigEditRequest | UserinfoResponseConfigEditRequest |
| actualName | 表中或类中名称 | false | string | ||
| extend | 是否为扩展字段 | false | integer(int32) | ||
| responseName | 返回给前端的名称 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«UserinfoResponseConfig对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | UserinfoResponseConfig对象 | UserinfoResponseConfig对象 |
| actualName | 类中或表中名称 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| extend | 是否为扩展字段 | integer(int32) | |
| id | 配置主键 | string | |
| responseName | 返回给前端的名称 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"actualName": "",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"extend": 0,
"id": "",
"responseName": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 删除返回配置信息
接口地址:/api/apusic/v1.0/userinforesponseconfig/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
李春阳---删除已配置的信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询已配置的信息
接口地址:/api/apusic/v1.0/userinforesponseconfig/{tenantId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
李春阳---查询某租户下已配置的信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| tenantId | tenantId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserinfoResponseConfig对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserinfoResponseConfig对象 |
| actualName | 类中或表中名称 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| extend | 是否为扩展字段 | integer(int32) | |
| id | 配置主键 | string | |
| responseName | 返回给前端的名称 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"actualName": "",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"extend": 0,
"id": "",
"responseName": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 1-02-角色接口文档模块
# 查询角色接口
接口地址:/api/apusic/v1.0/role
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询角色信息地址
请求示例:
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"id": "0b87cc22155849f78c07a79010e42641",
"name": "人力资源总监",
"order": "",
"orderBy": "",
"status": 1,
"tenantId": 5641566,
"username": "zhangsan/张三"
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| request | 角色查询筛选条件类 | body | true | RolesQueryFilter | RolesQueryFilter |
| authDomain | 权限域（选择的权限域中的域id） | false | string | ||
| id | 角色主键 | false | string | ||
| name | 角色名称（唯一） | false | string | ||
| order | false | string | |||
| orderBy | false | string | |||
| status | 角色状态(1为启用，0为停用) | false | string | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string | ||
| username | 用户名/姓名(模糊查询) | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Roles对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer(int32) | |
| status | 角色状态(1为启用，0为停用) | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户数量 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 新增角色接口
接口地址:/api/apusic/v1.0/role
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---新增角色信息地址(只有角色名称name，权限域主键authDomain，三个字段都不同才可以新增成功)
请求示例:
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"description": "人力资源总监",
"name": "人力资源总监",
"status": 1,
"tenantId": 5641566
}
1
2
3
4
5
6
7
2
3
4
5
6
7
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 创建角色请求类 | body | true | RolesCreateRequest | RolesCreateRequest |
| authDomain | 权限域（选择的权限域中的域id） | false | string | ||
| description | 描述 | false | string | ||
| name | 角色名称（唯一） | false | string | ||
| status | 角色状态(1为启用，0为停用) | false | string | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Roles对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Roles对象 | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer(int32) | |
| status | 角色状态(1为启用，0为停用) | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户数量 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 查询单个角色信息
接口地址:/api/apusic/v1.0/role/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询单个角色信息(id为角色主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Roles对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Roles对象 | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer(int32) | |
| status | 角色状态(1为启用，0为停用) | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户数量 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 修改角色接口
接口地址:/api/apusic/v1.0/role/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改角色信息地址(id为角色主键，实体类为修改内容)
请求示例:
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"description": "人力资源总监",
"name": "人力资源总监",
"status": 1,
"tenantId": 5641566
}
1
2
3
4
5
6
7
2
3
4
5
6
7
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 角色信息修改实体类 | body | true | RolesEditRequest | RolesEditRequest |
| authDomain | 权限域（选择的权限域中的域id） | false | string | ||
| description | 描述 | false | string | ||
| name | 角色名称（唯一） | false | string | ||
| status | 角色状态(1为启用，0为停用) | false | string | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Roles对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Roles对象 | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer(int32) | |
| status | 角色状态(1为启用，0为停用) | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户数量 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 删除角色接口
接口地址:/api/apusic/v1.0/role/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---删除角色接口信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Roles对象» |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Roles对象 | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer(int32) | |
| status | 角色状态(1为启用，0为停用) | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户数量 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 角色停用-启用接口
接口地址:/api/apusic/v1.0/role/{id}/{status}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---角色停用/启用信息地址(id为角色主键，status为停用/启用状态)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| status | status | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Roles对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Roles对象 | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer(int32) | |
| status | 角色状态(1为启用，0为停用) | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户数量 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 1-03-1-角色用户接口文档模块
# 给角色添加用户接口
接口地址:/api/apusic/v1.0/rolemember
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---给角色添加用户接口(可批量分配)
请求示例:
{
"memberIdList": [],
"rolesId": "2a578e050c0048bd917c205446ed4218",
"tenantId": ""
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| roleMemberCreateRequest | 添加成员角色请求类 | body | true | RoleMemberCreateRequest | RoleMemberCreateRequest |
| memberIdList | 成员主键id集合 | false | array | string | |
| rolesId | 角色主键id | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询角色下未选中用户接口
接口地址:/api/apusic/v1.0/rolemember/roles/unuser
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询角色下未选中用户接口(传参1:id(角色主键,必填),2:租户id(不填则默认为0),3:username用户姓名/用户名(选填,模糊查询))
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authDomain | 权限域（选择的权限域中的域id） | query | false | string | |
| id | 角色主键 | query | false | string | |
| name | 角色名称（唯一） | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| status | 角色状态(1为启用，0为停用) | query | false | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| username | 用户名/姓名(模糊查询) | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 查询角色下用户接口
接口地址:/api/apusic/v1.0/rolemember/roles/user
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询角色下用户地址(传参1:id(角色主键,必填),2:租户id(不填则默认为0),3:username用户姓名/用户名(选填,模糊查询))
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authDomain | 权限域（选择的权限域中的域id） | query | false | string | |
| id | 角色主键 | query | false | string | |
| name | 角色名称（唯一） | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| status | 角色状态(1为启用，0为停用) | query | false | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| username | 用户名/姓名(模糊查询) | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 为用户分配角色接口
接口地址:/api/apusic/v1.0/rolemember/user/roles
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---为用户分配角色(可批量分配)
请求示例:
{
"rolesIdList": [],
"tenantId": "",
"userInfoId": "2a578e050c0048bd917c205446ed4218"
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| memberRoleListCreateRequest | 添加用户分配角色请求类 | body | true | MemberRoleListCreateRequest | MemberRoleListCreateRequest |
| rolesIdList | 角色主键id集合 | false | array | string | |
| tenantId | 租户id | false | string | ||
| userInfoId | 用户主键id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询用户下未选中角色接口
接口地址:/api/apusic/v1.0/rolemember/user/unrole
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询用户下未选中角色接口(传参1:id(用户主键,必填),2:租户id(不填则默认为0),3:角色名(选填,模糊查询))
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authDomain | 权限域（选择的权限域中的域id） | query | false | string | |
| id | 角色主键 | query | false | string | |
| name | 角色名称（唯一） | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| status | 角色状态(1为启用，0为停用) | query | false | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| username | 用户名/姓名(模糊查询) | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 移除某角色中指定用户
接口地址:/api/apusic/v1.0/rolemember/{roleId}/{userInfoId}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---移除某角色中指定用户(roleId:角色主键；userInfoId：用户主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| roleId | roleId | path | true | string | |
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询用户所属角色接口
接口地址:/api/apusic/v1.0/rolemember/{userInfoId}/roles
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询用户所属角色地址()
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-03-2-角色组织接口文档模块
# 为组织分配角色接口
接口地址:/api/apusic/v1.0/roleorg/roles/orgs
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---为组织分配角色(可批量分配)，租户id默认为0
请求示例:
{
"memberIdList": [],
"rolesId": "2a578e050c0048bd917c205446ed4218",
"tenantId": ""
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| roleMemberCreateRequest | 添加成员角色请求类 | body | true | RoleMemberCreateRequest | RoleMemberCreateRequest |
| memberIdList | 成员主键id集合 | false | array | string | |
| rolesId | 角色主键id | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询角色下组织接口
接口地址:/api/apusic/v1.0/roleorg/roles/orgs/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查询角色下组织地址(id为角色主键id)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«IPage» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | IPage | IPage |
| current | integer(int64) | ||
| hitCount | boolean | ||
| pages | integer(int64) | ||
| records | array | object | |
| searchCount | boolean | ||
| size | integer(int64) | ||
| total | integer(int64) | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"current": 0,
"hitCount": true,
"pages": 0,
"records": [],
"searchCount": true,
"size": 0,
"total": 0
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 移除某角色中指定组织
接口地址:/api/apusic/v1.0/roleorg/roles/orgs/{roleId}/{orgId}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---移除某角色中指定用户(roleId:角色主键；orgId：组织主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| orgId | orgId | path | true | string | |
| roleId | roleId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-04-资源模块
# 查询所有资源模块
接口地址:/api/apusic/v1.0/resource
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---查询所有资源模块
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Resources查询对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Resources查询对象Res |
| appId | 应用id | string | |
| authDomainName | 权限分组名称 | string | |
| createTime | 创建时间 | string(date-time) | |
| id | id | string | |
| name | 资源名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| status | 资源状态，0表示用户自己的资源可以删除，1表示分组和角色的资源不可删除 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appId": "",
"authDomainName": "",
"createTime": "",
"id": "",
"name": "",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"status": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 新增资源模块
接口地址:/api/apusic/v1.0/resource
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---新增资源信息地址
请求示例:
{
"authDomain": "",
"description": "",
"name": "",
"parentId": 5641566,
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"sortIndex": 1,
"tenantId": 5641566
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourcesCreateRequest | resourcesCreateRequest | body | true | 资源创建请求对象 | 资源创建请求对象 |
| authDomain | 权限id | false | string | ||
| description | 描述 | false | string | ||
| name | 资源名称 | false | string | ||
| parentId | 父及节点id | false | string | ||
| resourceIcon | 资源图标 | false | string | ||
| resourceType | 资源类型 | false | string | ||
| resourceUrl | 资源标识 | false | string | ||
| sortIndex | 节点在同级子树下的排序 | false | integer(int32) | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Resources» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Resources | Resources |
| appId | string | ||
| appName | string | ||
| authDomain | string | ||
| authDomainName | 权限分组名称 | string | |
| childPasswordStatus | 是否需要子账号密码 | integer(int32) | |
| createBy | string | ||
| createTime | string(date-time) | ||
| description | string | ||
| groupId | 分组id | string | |
| id | string | ||
| name | string | ||
| parentId | string | ||
| parentName | string | ||
| protocol | 单点登录类型 | string | |
| resourceAction | string | ||
| resourceIcon | string | ||
| resourceStyle | string | ||
| resourceType | string | ||
| resourceUrl | string | ||
| rolesId | string | ||
| sortIndex | integer(int32) | ||
| status | integer(int32) | ||
| subAccountStatus | 是否拥有子账户（1表示有子账户 0表示没有子账户） | integer(int32) | |
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string(date-time) | ||
| userId | string | ||
| userInfoId | string | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appId": "",
"appName": "",
"authDomain": "",
"authDomainName": "",
"childPasswordStatus": 0,
"createBy": "",
"createTime": "",
"description": "",
"groupId": "",
"id": "",
"name": "",
"parentId": "",
"parentName": "",
"protocol": "",
"resourceAction": "",
"resourceIcon": "",
"resourceStyle": "",
"resourceType": "",
"resourceUrl": "",
"rolesId": "",
"sortIndex": 0,
"status": 0,
"subAccountStatus": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userInfoId": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# 查询(根据资源名模糊查询)所有根据权限分类资源
接口地址:/api/apusic/v1.0/resource/authDomain
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---(根据资源名模糊查询)所有根据权限分类资源
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| resourceName | resourceName | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«权限资源分组VO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | 权限资源分组VO |
| authDomainName | string | ||
| id | string | ||
| resourcesList | array | Resources | |
| appId | string | ||
| appName | string | ||
| authDomain | string | ||
| authDomainName | 权限分组名称 | string | |
| childPasswordStatus | 是否需要子账号密码 | integer | |
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| groupId | 分组id | string | |
| id | string | ||
| name | string | ||
| parentId | string | ||
| parentName | string | ||
| protocol | 单点登录类型 | string | |
| resourceAction | string | ||
| resourceIcon | string | ||
| resourceStyle | string | ||
| resourceType | string | ||
| resourceUrl | string | ||
| rolesId | string | ||
| sortIndex | integer | ||
| status | integer | ||
| subAccountStatus | 是否拥有子账户（1表示有子账户 0表示没有子账户） | integer | |
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userId | string | ||
| userInfoId | string | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomainName": "",
"id": "",
"resourcesList": [
{
"appId": "",
"appName": "",
"authDomain": "",
"authDomainName": "",
"childPasswordStatus": 0,
"createBy": "",
"createTime": "",
"description": "",
"groupId": "",
"id": "",
"name": "",
"parentId": "",
"parentName": "",
"protocol": "",
"resourceAction": "",
"resourceIcon": "",
"resourceStyle": "",
"resourceType": "",
"resourceUrl": "",
"rolesId": "",
"sortIndex": 0,
"status": 0,
"subAccountStatus": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userInfoId": ""
}
]
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# 查询(模糊查询)角色下资源接口,已经授权过的disabled设置为true
接口地址:/api/apusic/v1.0/resource/roles/unresource
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---查询角色下未选中资源接口(传参1:rolesId(角色主键),2:租户id(不填则默认为0),3:资源名(选填,模糊查询))
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authDomain | 权限人 | query | false | string | |
| groupId | 分组id | query | false | string | |
| id | id | query | false | string | |
| name | 资源名称 | query | false | string | |
| resourceIdList | 资源id集合 | query | false | array | string |
| resourceType | 资源类型 | query | false | string | |
| rolesId | 角色id | query | false | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| userInfoId | 用户id | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 将资源批量分配给角色
接口地址:/api/apusic/v1.0/resource/rolesResource
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---将资源批量分配给角色
请求示例:
{
"authDomain": "",
"groupId": "",
"id": "",
"name": "",
"resourceIdList": [],
"resourceType": "",
"rolesId": "",
"tenantId": "",
"userInfoId": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourcesQueryFilter | resourcesQueryFilter | body | true | Resources查询对象Req | Resources查询对象Req |
| authDomain | 权限人 | false | string | ||
| groupId | 分组id | false | string | ||
| id | id | false | string | ||
| name | 资源名称 | false | string | ||
| resourceIdList | 资源id集合 | false | array | string | |
| resourceType | 资源类型 | false | string | ||
| rolesId | 角色id | false | string | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string | ||
| userInfoId | 用户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询(模糊查询)用户下的资源接口,已经授权过的disabled设置为true
接口地址:/api/apusic/v1.0/resource/user/unresource
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---查询用户下未选中资源接口(传参1:userInfoId(用户主键）),2:租户id(不填则默认为0),3:资源名(选填,模糊查询))
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authDomain | 权限人 | query | false | string | |
| groupId | 分组id | query | false | string | |
| id | id | query | false | string | |
| name | 资源名称 | query | false | string | |
| resourceIdList | 资源id集合 | query | false | array | string |
| resourceType | 资源类型 | query | false | string | |
| rolesId | 角色id | query | false | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| userInfoId | 用户id | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 查询资源详情模块
接口地址:/api/apusic/v1.0/resource/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---查询资源详情信息地址 id为资源id
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Resources对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Resources对象 | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer(int32) | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# 修改资源模块
接口地址:/api/apusic/v1.0/resource/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---修改资源信息地址
请求示例:
{
"authDomain": "",
"description": "",
"name": "",
"parentId": 5641566,
"resourceType": "",
"resourceUrl": "",
"sortIndex": 1,
"tenantId": 5641566
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| resourcesEditRequest | resourcesEditRequest | body | true | 资源修改请求对象 | 资源修改请求对象 |
| authDomain | 权限id | false | string | ||
| description | 描述 | false | string | ||
| name | 资源名称 | false | string | ||
| parentId | 父及节点id | false | string | ||
| resourceType | 资源类型 | false | string | ||
| resourceUrl | 资源标识 | false | string | ||
| sortIndex | 节点在同级子树下的排序 | false | integer(int32) | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除资源模块
接口地址:/api/apusic/v1.0/resource/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---删除资源信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询某类型的资源列表
接口地址:/api/apusic/v1.0/resource/{resourceType}/resourceType
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---查询某类型的资源列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourceType | resourceType | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Resources查询对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Resources查询对象Res |
| appId | 应用id | string | |
| authDomainName | 权限分组名称 | string | |
| createTime | 创建时间 | string(date-time) | |
| id | id | string | |
| name | 资源名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| status | 资源状态，0表示用户自己的资源可以删除，1表示分组和角色的资源不可删除 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appId": "",
"authDomainName": "",
"createTime": "",
"id": "",
"name": "",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"status": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 根据用户查询用户指定类型的资源列表
接口地址:/api/apusic/v1.0/resource/{resourceType}/{userInfoId}/resourceType
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---根据用户查询用户指定类型的资源列表(resourceType为查询APP类型资源)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourceType | resourceType | path | true | string | |
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«用户登录后门户首页查看的应用列表VO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | 用户登录后门户首页查看的应用列表VO |
| appId | 应用id | string | |
| authDomainName | 权限分组名称 | string | |
| childPasswordStatus | 是否需要子账号密码 | integer(int32) | |
| createTime | 创建时间 | string(date-time) | |
| id | id | string | |
| loginBtnSelector | string | ||
| loginPwdSelector | string | ||
| loginUsernameSelector | string | ||
| name | 资源名称 | string | |
| protocol | 单点登录类型 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| status | 资源状态，0表示用户自己的资源可以删除，1表示分组和角色的资源不可删除 | integer(int32) | |
| subAccountStatus | 是否拥有子账户（1表示有子账户 0表示没有子账户） | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appId": "",
"authDomainName": "",
"childPasswordStatus": 0,
"createTime": "",
"id": "",
"loginBtnSelector": "",
"loginPwdSelector": "",
"loginUsernameSelector": "",
"name": "",
"protocol": "",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"status": 0,
"subAccountStatus": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 根据角色查询资源列表
接口地址:/api/apusic/v1.0/resource/{rolesId}/rolesResource
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---根据角色查询资源列表(rolesId 角色id)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| rolesId | rolesId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«ResourceUserInfoVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | ResourceUserInfoVO |
| authDomainId | string | ||
| authDomainName | 权限分组名称 | string | |
| children | 子节点 | array | ResourceUserInfoVO |
| createTime | 创建时间 | string(date-time) | |
| description | string | ||
| id | id | string | |
| level | integer(int32) | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceType | 资源类型 | string | |
| sortIndex | 排序 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 移除某角色的资源
接口地址:/api/apusic/v1.0/resource/{rolesId}/{resourceId}/rolesResource
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---移除某角色的资源(rolesId 角色id resourceId资源id)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourceId | resourceId | path | true | string | |
| rolesId | rolesId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询用户的所属资源
接口地址:/api/apusic/v1.0/resource/{userInfoId}/authDomain
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---查询用户的所属资源
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«ResourceUserInfoVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | ResourceUserInfoVO |
| authDomainId | string | ||
| authDomainName | 权限分组名称 | string | |
| children | 子节点 | array | ResourceUserInfoVO |
| createTime | 创建时间 | string(date-time) | |
| description | string | ||
| id | id | string | |
| level | integer(int32) | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceType | 资源类型 | string | |
| sortIndex | 排序 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 为用户批量分配指定资源
接口地址:/api/apusic/v1.0/resource/{userInfoId}/userInfoResource
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---为用户批量分配指定资源
请求示例:
[]
1
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourceIdList | resourceIdList | body | true | array | string |
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 为用户删除指定资源
接口地址:/api/apusic/v1.0/resource/{userInfoId}/{resourceId}/userInfoResource
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---为用户删除指定资源(userInfoId 用户id resourceId 资源id)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourceId | resourceId | path | true | string | |
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-05-应用接口文档模块
# 查询应用列表接口
接口地址:/api/apusic/v1.0/apps
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询应用列表（根据协议查询需要传入）
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appCategory | 应用类型(集成应用/标准协议) | query | false | string | |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | query | false | integer(int32) | |
| id | 应用主键 | query | false | string | |
| name | 应用名称 | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| protocol | 应用协议类型 | query | false | string | |
| status | 状态 | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«App»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | App |
| adapter | 适配器 | string | |
| adapterId | 适配器id | string | |
| adapterName | 适配器名称 | string | |
| appCategory | 应用类型(集成应用/标准协议) | string | |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appUser | App用户 | Accounts | Accounts |
| appId | string | ||
| appName | string | ||
| createBy | string | ||
| createTime | string | ||
| createType | string | ||
| description | string | ||
| displayName | string | ||
| id | string | ||
| orgCast | OrganizationsCast | OrganizationsCast | |
| code | string | ||
| codePath | string | ||
| createBy | string | ||
| createTime | string | ||
| fullName | string | ||
| id | string | ||
| name | string | ||
| namePath | string | ||
| orgId | string | ||
| orgParentId | string | ||
| parentId | string | ||
| parentName | string | ||
| provider | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| relatedPassword | string | ||
| relatedUserName | string | ||
| status | integer | ||
| strategyId | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userId | string | ||
| userInfo | UserInfo | UserInfo | |
| adjectiveTime | string | ||
| appIdList | array | string | |
| appLoginAuthnType | integer | ||
| appLoginPassword | string | ||
| appsList | array | Apps | |
| adapter | string | ||
| adapterId | string | ||
| adapterName | string | ||
| appCategory | string | ||
| appCategoryStatus | integer | ||
| appUser | Accounts | Accounts | |
| category | string | ||
| createBy | string | ||
| createTime | string | ||
| credential | integer | ||
| credentials | string | ||
| description | string | ||
| extendAttr | string | ||
| icon | string | ||
| iconFile | file | ||
| iconUrl | string | ||
| id | string | ||
| inducer | string | ||
| isAdapter | integer | ||
| isExtendAttr | integer | ||
| isSignature | integer | ||
| loginDateTime | string | ||
| loginUrl | string | ||
| logoutType | integer | ||
| logoutUrl | string | ||
| name | string | ||
| onlineTicket | string | ||
| principal | string | ||
| protocol | string | ||
| secret | string | ||
| sharedPassword | string | ||
| sharedUsername | string | ||
| sortIndex | integer | ||
| status | integer | ||
| systemUserAttr | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userPropertys | string | ||
| vendor | string | ||
| vendorUrl | string | ||
| visible | integer | ||
| assistant | string | ||
| assistantId | string | ||
| authnType | integer | ||
| badPasswordCount | integer | ||
| badPasswordTime | string | ||
| birthDate | string | ||
| containsChildren | integer | ||
| costCenter | string | ||
| createBy | string | ||
| createTime | string | ||
| decipherable | string | ||
| defineIm | string | ||
| department | string | ||
| departmentId | string | ||
| description | string | ||
| displayName | string | ||
| division | string | ||
| string | |||
| emailTemplateStatus | integer | ||
| emailVerified | integer | ||
| employeeNumber | string | ||
| entryDate | string | ||
| expireStatus | integer | ||
| expireTime | string | ||
| extendDataList | array | UserinfoExtendAttrData | |
| createBy | string | ||
| createTime | string | ||
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| id | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userinfoId | string | ||
| extraAttribute | string | ||
| extraAttributeMap | object | ||
| extraAttributeName | string | ||
| extraAttributeValue | string | ||
| familyName | string | ||
| formattedName | string | ||
| gender | integer | ||
| givenName | string | ||
| gridList | integer | ||
| homeAddressFormatted | string | ||
| homeCountry | string | ||
| homeEmail | string | ||
| homeFax | string | ||
| homeLocality | string | ||
| homePhoneNumber | string | ||
| homePostalCode | string | ||
| homeRegion | string | ||
| homeStreetAddress | string | ||
| honorificPrefix | string | ||
| honorificSuffix | string | ||
| id | string | ||
| idCardNo | string | ||
| idType | integer | ||
| isLocked | integer | ||
| isLockedTime | string | ||
| jobLevel | string | ||
| jobTitle | string | ||
| lastLoginIp | string | ||
| lastLoginTime | string | ||
| lastLogoffTime | string | ||
| ldapDn | string | ||
| locale | string | ||
| loginCount | integer | ||
| manager | string | ||
| managerId | string | ||
| managerType | integer | ||
| married | integer | ||
| middleName | string | ||
| mobile | string | ||
| mobileTemplateStatus | integer | ||
| mobileVerified | integer | ||
| nameZhShortSpell | string | ||
| nameZhSpell | string | ||
| nickName | string | ||
| online | integer | ||
| org | string | ||
| orgIdList | array | string | |
| orgList | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| orgNamePath | string | ||
| organization | string | ||
| orgs | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| password | string | ||
| passwordAnswer | string | ||
| passwordCycle | integer | ||
| passwordLastSetTime | string | ||
| passwordQuestion | string | ||
| passwordSetType | integer | ||
| picture | string | ||
| pictureFile | file | ||
| preferredLanguage | string | ||
| protected_apps | string | ||
| quitDate | string | ||
| randomPassword | string | ||
| roles | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| rolesIdList | array | string | |
| rolesList | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| sharedCounter | string | ||
| sharedSecret | string | ||
| sortOrder | integer | ||
| startWorkDate | string | ||
| status | integer | ||
| tenantId | string | ||
| theme | string | ||
| timeZone | string | ||
| unLockTime | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userState | string | ||
| userType | string | ||
| username | string | ||
| webSite | string | ||
| weixinFollow | integer | ||
| windowsAccount | string | ||
| workAddressFormatted | string | ||
| workCountry | string | ||
| workEmail | string | ||
| workFax | string | ||
| workLocality | string | ||
| workOfficeName | string | ||
| workPhoneNumber | string | ||
| workPostalCode | string | ||
| workRegion | string | ||
| workStreetAddress | string | ||
| userName | string | ||
| category | 应用类型(系统分类) | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| credential | 单点登录凭证类型 | integer(int32) | |
| credentials | 接口API用户凭证 | string | |
| description | 描述 | string | |
| extendAttr | 应用扩展属性 | string | |
| iconUrl | 应用图标存储地址 | string | |
| id | 应用主键 | string | |
| inducer | 引导方式 | string | |
| isAdapter | 是否支持适配器 | integer(int32) | |
| isExtendAttr | 是否支持应用扩展属性 | integer(int32) | |
| isSignature | 签名状态 | integer(int32) | |
| loginDateTime | 登录时间 | string | |
| loginUrl | 应用登录地址 | string | |
| logoutType | 单点注销方式 0 NONE,1 BACK_CHANNEL,2 FRONT_CHANNEL | integer(int32) | |
| logoutUrl | 注销地址 | string | |
| name | 应用名称 | string | |
| onlineTicket | 在线标识 | string | |
| principal | 接口API用户 | string | |
| protocol | 单点登录协议 | string | |
| secret | 应用密钥 | string | |
| sharedPassword | 共享密码 | string | |
| sharedUsername | 共享用户名 | string | |
| sortIndex | 排序序号 | integer(int32) | |
| status | 状态 | integer(int32) | |
| systemUserAttr | 系统用户属性 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userPropertys | 接口返回用户属性定义 | string | |
| vendor | 供应商 | string | |
| vendorUrl | 供应商网址 | string | |
| visible | 可见标识 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"adapter": "com.apusic.idm.v1.authz.cas.endpoint.adapter.CasDefaultAdapter",
"adapterId": "",
"adapterName": "CAS默认适配器",
"appCategory": "OAuth_v2.0",
"appCategoryStatus": 1,
"appUser": {
"appId": "",
"appName": "",
"createBy": "",
"createTime": "",
"createType": "",
"description": "",
"displayName": "",
"id": "",
"orgCast": {
"additionalProperties1": {
"code": "",
"codePath": "",
"createBy": "",
"createTime": "",
"fullName": "",
"id": "",
"name": "",
"namePath": "",
"orgId": "",
"orgParentId": "",
"parentId": "",
"parentName": "",
"provider": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": ""
}
},
"relatedPassword": "",
"relatedUserName": "",
"status": 0,
"strategyId": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userInfo": {
"adjectiveTime": "",
"appIdList": [],
"appLoginAuthnType": 0,
"appLoginPassword": "",
"appsList": [
{
"adapter": "",
"adapterId": "",
"adapterName": "",
"appCategory": "",
"appCategoryStatus": 0,
"appUser": {},
"category": "",
"createBy": "",
"createTime": "",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "",
"icon": "",
"iconFile": "",
"iconUrl": "",
"id": "",
"inducer": "",
"isAdapter": 0,
"isExtendAttr": 0,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "",
"logoutType": 0,
"logoutUrl": "",
"name": "",
"onlineTicket": "",
"principal": "",
"protocol": "",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 0,
"status": 0,
"systemUserAttr": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userPropertys": "",
"vendor": "",
"vendorUrl": "",
"visible": 0
}
],
"assistant": "",
"assistantId": "",
"authnType": 0,
"badPasswordCount": 0,
"badPasswordTime": "",
"birthDate": "",
"containsChildren": 0,
"costCenter": "",
"createBy": "",
"createTime": "",
"decipherable": "",
"defineIm": "",
"department": "",
"departmentId": "",
"description": "",
"displayName": "",
"division": "",
"email": "",
"emailTemplateStatus": 0,
"emailVerified": 0,
"employeeNumber": "",
"entryDate": "",
"expireStatus": 0,
"expireTime": "",
"extendDataList": [
{
"createBy": "",
"createTime": "",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"id": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userinfoId": ""
}
],
"extraAttribute": "",
"extraAttributeMap": {},
"extraAttributeName": "",
"extraAttributeValue": "",
"familyName": "",
"formattedName": "",
"gender": 0,
"givenName": "",
"gridList": 0,
"homeAddressFormatted": "",
"homeCountry": "",
"homeEmail": "",
"homeFax": "",
"homeLocality": "",
"homePhoneNumber": "",
"homePostalCode": "",
"homeRegion": "",
"homeStreetAddress": "",
"honorificPrefix": "",
"honorificSuffix": "",
"id": "",
"idCardNo": "",
"idType": 0,
"isLocked": 0,
"isLockedTime": "",
"jobLevel": "",
"jobTitle": "",
"lastLoginIp": "",
"lastLoginTime": "",
"lastLogoffTime": "",
"ldapDn": "",
"locale": "",
"loginCount": 0,
"manager": "",
"managerId": "",
"managerType": 0,
"married": 0,
"middleName": "",
"mobile": "",
"mobileTemplateStatus": 0,
"mobileVerified": 0,
"nameZhShortSpell": "",
"nameZhSpell": "",
"nickName": "",
"online": 0,
"org": "",
"orgIdList": [],
"orgList": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"orgNamePath": "",
"organization": "",
"orgs": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"password": "",
"passwordAnswer": "",
"passwordCycle": 0,
"passwordLastSetTime": "",
"passwordQuestion": "",
"passwordSetType": 0,
"picture": "",
"pictureFile": "",
"preferredLanguage": "",
"protected_apps": "",
"quitDate": "",
"randomPassword": "",
"roles": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"rolesIdList": [],
"rolesList": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"sharedCounter": "",
"sharedSecret": "",
"sortOrder": 0,
"startWorkDate": "",
"status": 0,
"tenantId": "",
"theme": "",
"timeZone": "",
"unLockTime": "",
"updateBy": "",
"updateTime": "",
"userState": "",
"userType": "",
"username": "",
"webSite": "",
"weixinFollow": 0,
"windowsAccount": "",
"workAddressFormatted": "",
"workCountry": "",
"workEmail": "",
"workFax": "",
"workLocality": "",
"workOfficeName": "",
"workPhoneNumber": "",
"workPostalCode": "",
"workRegion": "",
"workStreetAddress": ""
},
"userName": ""
},
"category": "HR",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "[{\"attr\":\"1\",\"type\":\"1\",\"value\":\"1\"}]",
"iconUrl": "",
"id": "0b87cc22155849f78c07a79010e42641",
"inducer": "IDP",
"isAdapter": 0,
"isExtendAttr": 1,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "http://www.apusic.com",
"logoutType": 0,
"logoutUrl": "",
"name": "招聘管理系统",
"onlineTicket": "",
"principal": "",
"protocol": "OAuth_v2.0",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 1,
"status": 0,
"systemUserAttr": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userPropertys": "userId,username,email,employeeNumber,departmentId,department,windowsAccount",
"vendor": "APUSIC",
"vendorUrl": "http://www.apusic.com",
"visible": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# 跳往添加应用
接口地址:/api/apusic/v1.0/apps/forward
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---跳往添加应用
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 根据id查询应用信息
接口地址:/api/apusic/v1.0/apps/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---根据id查询应用信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«App» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | App | App |
| adapter | 适配器 | string | |
| adapterId | 适配器id | string | |
| adapterName | 适配器名称 | string | |
| appCategory | 应用类型(集成应用/标准协议) | string | |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appUser | App用户 | Accounts | Accounts |
| appId | string | ||
| appName | string | ||
| createBy | string | ||
| createTime | string | ||
| createType | string | ||
| description | string | ||
| displayName | string | ||
| id | string | ||
| orgCast | OrganizationsCast | OrganizationsCast | |
| code | string | ||
| codePath | string | ||
| createBy | string | ||
| createTime | string | ||
| fullName | string | ||
| id | string | ||
| name | string | ||
| namePath | string | ||
| orgId | string | ||
| orgParentId | string | ||
| parentId | string | ||
| parentName | string | ||
| provider | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| relatedPassword | string | ||
| relatedUserName | string | ||
| status | integer | ||
| strategyId | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userId | string | ||
| userInfo | UserInfo | UserInfo | |
| adjectiveTime | string | ||
| appIdList | array | string | |
| appLoginAuthnType | integer | ||
| appLoginPassword | string | ||
| appsList | array | Apps | |
| adapter | string | ||
| adapterId | string | ||
| adapterName | string | ||
| appCategory | string | ||
| appCategoryStatus | integer | ||
| appUser | Accounts | Accounts | |
| category | string | ||
| createBy | string | ||
| createTime | string | ||
| credential | integer | ||
| credentials | string | ||
| description | string | ||
| extendAttr | string | ||
| icon | string | ||
| iconFile | file | ||
| iconUrl | string | ||
| id | string | ||
| inducer | string | ||
| isAdapter | integer | ||
| isExtendAttr | integer | ||
| isSignature | integer | ||
| loginDateTime | string | ||
| loginUrl | string | ||
| logoutType | integer | ||
| logoutUrl | string | ||
| name | string | ||
| onlineTicket | string | ||
| principal | string | ||
| protocol | string | ||
| secret | string | ||
| sharedPassword | string | ||
| sharedUsername | string | ||
| sortIndex | integer | ||
| status | integer | ||
| systemUserAttr | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userPropertys | string | ||
| vendor | string | ||
| vendorUrl | string | ||
| visible | integer | ||
| assistant | string | ||
| assistantId | string | ||
| authnType | integer | ||
| badPasswordCount | integer | ||
| badPasswordTime | string | ||
| birthDate | string | ||
| containsChildren | integer | ||
| costCenter | string | ||
| createBy | string | ||
| createTime | string | ||
| decipherable | string | ||
| defineIm | string | ||
| department | string | ||
| departmentId | string | ||
| description | string | ||
| displayName | string | ||
| division | string | ||
| string | |||
| emailTemplateStatus | integer | ||
| emailVerified | integer | ||
| employeeNumber | string | ||
| entryDate | string | ||
| expireStatus | integer | ||
| expireTime | string | ||
| extendDataList | array | UserinfoExtendAttrData | |
| createBy | string | ||
| createTime | string | ||
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| id | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userinfoId | string | ||
| extraAttribute | string | ||
| extraAttributeMap | object | ||
| extraAttributeName | string | ||
| extraAttributeValue | string | ||
| familyName | string | ||
| formattedName | string | ||
| gender | integer | ||
| givenName | string | ||
| gridList | integer | ||
| homeAddressFormatted | string | ||
| homeCountry | string | ||
| homeEmail | string | ||
| homeFax | string | ||
| homeLocality | string | ||
| homePhoneNumber | string | ||
| homePostalCode | string | ||
| homeRegion | string | ||
| homeStreetAddress | string | ||
| honorificPrefix | string | ||
| honorificSuffix | string | ||
| id | string | ||
| idCardNo | string | ||
| idType | integer | ||
| isLocked | integer | ||
| isLockedTime | string | ||
| jobLevel | string | ||
| jobTitle | string | ||
| lastLoginIp | string | ||
| lastLoginTime | string | ||
| lastLogoffTime | string | ||
| ldapDn | string | ||
| locale | string | ||
| loginCount | integer | ||
| manager | string | ||
| managerId | string | ||
| managerType | integer | ||
| married | integer | ||
| middleName | string | ||
| mobile | string | ||
| mobileTemplateStatus | integer | ||
| mobileVerified | integer | ||
| nameZhShortSpell | string | ||
| nameZhSpell | string | ||
| nickName | string | ||
| online | integer | ||
| org | string | ||
| orgIdList | array | string | |
| orgList | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| orgNamePath | string | ||
| organization | string | ||
| orgs | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| password | string | ||
| passwordAnswer | string | ||
| passwordCycle | integer | ||
| passwordLastSetTime | string | ||
| passwordQuestion | string | ||
| passwordSetType | integer | ||
| picture | string | ||
| pictureFile | file | ||
| preferredLanguage | string | ||
| protected_apps | string | ||
| quitDate | string | ||
| randomPassword | string | ||
| roles | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| rolesIdList | array | string | |
| rolesList | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| sharedCounter | string | ||
| sharedSecret | string | ||
| sortOrder | integer | ||
| startWorkDate | string | ||
| status | integer | ||
| tenantId | string | ||
| theme | string | ||
| timeZone | string | ||
| unLockTime | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userState | string | ||
| userType | string | ||
| username | string | ||
| webSite | string | ||
| weixinFollow | integer | ||
| windowsAccount | string | ||
| workAddressFormatted | string | ||
| workCountry | string | ||
| workEmail | string | ||
| workFax | string | ||
| workLocality | string | ||
| workOfficeName | string | ||
| workPhoneNumber | string | ||
| workPostalCode | string | ||
| workRegion | string | ||
| workStreetAddress | string | ||
| userName | string | ||
| category | 应用类型(系统分类) | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| credential | 单点登录凭证类型 | integer(int32) | |
| credentials | 接口API用户凭证 | string | |
| description | 描述 | string | |
| extendAttr | 应用扩展属性 | string | |
| iconUrl | 应用图标存储地址 | string | |
| id | 应用主键 | string | |
| inducer | 引导方式 | string | |
| isAdapter | 是否支持适配器 | integer(int32) | |
| isExtendAttr | 是否支持应用扩展属性 | integer(int32) | |
| isSignature | 签名状态 | integer(int32) | |
| loginDateTime | 登录时间 | string | |
| loginUrl | 应用登录地址 | string | |
| logoutType | 单点注销方式 0 NONE,1 BACK_CHANNEL,2 FRONT_CHANNEL | integer(int32) | |
| logoutUrl | 注销地址 | string | |
| name | 应用名称 | string | |
| onlineTicket | 在线标识 | string | |
| principal | 接口API用户 | string | |
| protocol | 单点登录协议 | string | |
| secret | 应用密钥 | string | |
| sharedPassword | 共享密码 | string | |
| sharedUsername | 共享用户名 | string | |
| sortIndex | 排序序号 | integer(int32) | |
| status | 状态 | integer(int32) | |
| systemUserAttr | 系统用户属性 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userPropertys | 接口返回用户属性定义 | string | |
| vendor | 供应商 | string | |
| vendorUrl | 供应商网址 | string | |
| visible | 可见标识 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"adapter": "com.apusic.idm.v1.authz.cas.endpoint.adapter.CasDefaultAdapter",
"adapterId": "",
"adapterName": "CAS默认适配器",
"appCategory": "OAuth_v2.0",
"appCategoryStatus": 1,
"appUser": {
"appId": "",
"appName": "",
"createBy": "",
"createTime": "",
"createType": "",
"description": "",
"displayName": "",
"id": "",
"orgCast": {
"additionalProperties1": {
"code": "",
"codePath": "",
"createBy": "",
"createTime": "",
"fullName": "",
"id": "",
"name": "",
"namePath": "",
"orgId": "",
"orgParentId": "",
"parentId": "",
"parentName": "",
"provider": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": ""
}
},
"relatedPassword": "",
"relatedUserName": "",
"status": 0,
"strategyId": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userInfo": {
"adjectiveTime": "",
"appIdList": [],
"appLoginAuthnType": 0,
"appLoginPassword": "",
"appsList": [
{
"adapter": "",
"adapterId": "",
"adapterName": "",
"appCategory": "",
"appCategoryStatus": 0,
"appUser": {},
"category": "",
"createBy": "",
"createTime": "",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "",
"icon": "",
"iconFile": "",
"iconUrl": "",
"id": "",
"inducer": "",
"isAdapter": 0,
"isExtendAttr": 0,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "",
"logoutType": 0,
"logoutUrl": "",
"name": "",
"onlineTicket": "",
"principal": "",
"protocol": "",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 0,
"status": 0,
"systemUserAttr": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userPropertys": "",
"vendor": "",
"vendorUrl": "",
"visible": 0
}
],
"assistant": "",
"assistantId": "",
"authnType": 0,
"badPasswordCount": 0,
"badPasswordTime": "",
"birthDate": "",
"containsChildren": 0,
"costCenter": "",
"createBy": "",
"createTime": "",
"decipherable": "",
"defineIm": "",
"department": "",
"departmentId": "",
"description": "",
"displayName": "",
"division": "",
"email": "",
"emailTemplateStatus": 0,
"emailVerified": 0,
"employeeNumber": "",
"entryDate": "",
"expireStatus": 0,
"expireTime": "",
"extendDataList": [
{
"createBy": "",
"createTime": "",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"id": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userinfoId": ""
}
],
"extraAttribute": "",
"extraAttributeMap": {},
"extraAttributeName": "",
"extraAttributeValue": "",
"familyName": "",
"formattedName": "",
"gender": 0,
"givenName": "",
"gridList": 0,
"homeAddressFormatted": "",
"homeCountry": "",
"homeEmail": "",
"homeFax": "",
"homeLocality": "",
"homePhoneNumber": "",
"homePostalCode": "",
"homeRegion": "",
"homeStreetAddress": "",
"honorificPrefix": "",
"honorificSuffix": "",
"id": "",
"idCardNo": "",
"idType": 0,
"isLocked": 0,
"isLockedTime": "",
"jobLevel": "",
"jobTitle": "",
"lastLoginIp": "",
"lastLoginTime": "",
"lastLogoffTime": "",
"ldapDn": "",
"locale": "",
"loginCount": 0,
"manager": "",
"managerId": "",
"managerType": 0,
"married": 0,
"middleName": "",
"mobile": "",
"mobileTemplateStatus": 0,
"mobileVerified": 0,
"nameZhShortSpell": "",
"nameZhSpell": "",
"nickName": "",
"online": 0,
"org": "",
"orgIdList": [],
"orgList": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"orgNamePath": "",
"organization": "",
"orgs": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"password": "",
"passwordAnswer": "",
"passwordCycle": 0,
"passwordLastSetTime": "",
"passwordQuestion": "",
"passwordSetType": 0,
"picture": "",
"pictureFile": "",
"preferredLanguage": "",
"protected_apps": "",
"quitDate": "",
"randomPassword": "",
"roles": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"rolesIdList": [],
"rolesList": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"sharedCounter": "",
"sharedSecret": "",
"sortOrder": 0,
"startWorkDate": "",
"status": 0,
"tenantId": "",
"theme": "",
"timeZone": "",
"unLockTime": "",
"updateBy": "",
"updateTime": "",
"userState": "",
"userType": "",
"username": "",
"webSite": "",
"weixinFollow": 0,
"windowsAccount": "",
"workAddressFormatted": "",
"workCountry": "",
"workEmail": "",
"workFax": "",
"workLocality": "",
"workOfficeName": "",
"workPhoneNumber": "",
"workPostalCode": "",
"workRegion": "",
"workStreetAddress": ""
},
"userName": ""
},
"category": "HR",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "[{\"attr\":\"1\",\"type\":\"1\",\"value\":\"1\"}]",
"iconUrl": "",
"id": "0b87cc22155849f78c07a79010e42641",
"inducer": "IDP",
"isAdapter": 0,
"isExtendAttr": 1,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "http://www.apusic.com",
"logoutType": 0,
"logoutUrl": "",
"name": "招聘管理系统",
"onlineTicket": "",
"principal": "",
"protocol": "OAuth_v2.0",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 1,
"status": 0,
"systemUserAttr": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userPropertys": "userId,username,email,employeeNumber,departmentId,department,windowsAccount",
"vendor": "APUSIC",
"vendorUrl": "http://www.apusic.com",
"visible": 0
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# 删除应用
接口地址:/api/apusic/v1.0/apps/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---删除应用接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«App» |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | App | App |
| adapter | 适配器 | string | |
| adapterId | 适配器id | string | |
| adapterName | 适配器名称 | string | |
| appCategory | 应用类型(集成应用/标准协议) | string | |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appUser | App用户 | Accounts | Accounts |
| appId | string | ||
| appName | string | ||
| createBy | string | ||
| createTime | string | ||
| createType | string | ||
| description | string | ||
| displayName | string | ||
| id | string | ||
| orgCast | OrganizationsCast | OrganizationsCast | |
| code | string | ||
| codePath | string | ||
| createBy | string | ||
| createTime | string | ||
| fullName | string | ||
| id | string | ||
| name | string | ||
| namePath | string | ||
| orgId | string | ||
| orgParentId | string | ||
| parentId | string | ||
| parentName | string | ||
| provider | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| relatedPassword | string | ||
| relatedUserName | string | ||
| status | integer | ||
| strategyId | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userId | string | ||
| userInfo | UserInfo | UserInfo | |
| adjectiveTime | string | ||
| appIdList | array | string | |
| appLoginAuthnType | integer | ||
| appLoginPassword | string | ||
| appsList | array | Apps | |
| adapter | string | ||
| adapterId | string | ||
| adapterName | string | ||
| appCategory | string | ||
| appCategoryStatus | integer | ||
| appUser | Accounts | Accounts | |
| category | string | ||
| createBy | string | ||
| createTime | string | ||
| credential | integer | ||
| credentials | string | ||
| description | string | ||
| extendAttr | string | ||
| icon | string | ||
| iconFile | file | ||
| iconUrl | string | ||
| id | string | ||
| inducer | string | ||
| isAdapter | integer | ||
| isExtendAttr | integer | ||
| isSignature | integer | ||
| loginDateTime | string | ||
| loginUrl | string | ||
| logoutType | integer | ||
| logoutUrl | string | ||
| name | string | ||
| onlineTicket | string | ||
| principal | string | ||
| protocol | string | ||
| secret | string | ||
| sharedPassword | string | ||
| sharedUsername | string | ||
| sortIndex | integer | ||
| status | integer | ||
| systemUserAttr | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userPropertys | string | ||
| vendor | string | ||
| vendorUrl | string | ||
| visible | integer | ||
| assistant | string | ||
| assistantId | string | ||
| authnType | integer | ||
| badPasswordCount | integer | ||
| badPasswordTime | string | ||
| birthDate | string | ||
| containsChildren | integer | ||
| costCenter | string | ||
| createBy | string | ||
| createTime | string | ||
| decipherable | string | ||
| defineIm | string | ||
| department | string | ||
| departmentId | string | ||
| description | string | ||
| displayName | string | ||
| division | string | ||
| string | |||
| emailTemplateStatus | integer | ||
| emailVerified | integer | ||
| employeeNumber | string | ||
| entryDate | string | ||
| expireStatus | integer | ||
| expireTime | string | ||
| extendDataList | array | UserinfoExtendAttrData | |
| createBy | string | ||
| createTime | string | ||
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| id | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userinfoId | string | ||
| extraAttribute | string | ||
| extraAttributeMap | object | ||
| extraAttributeName | string | ||
| extraAttributeValue | string | ||
| familyName | string | ||
| formattedName | string | ||
| gender | integer | ||
| givenName | string | ||
| gridList | integer | ||
| homeAddressFormatted | string | ||
| homeCountry | string | ||
| homeEmail | string | ||
| homeFax | string | ||
| homeLocality | string | ||
| homePhoneNumber | string | ||
| homePostalCode | string | ||
| homeRegion | string | ||
| homeStreetAddress | string | ||
| honorificPrefix | string | ||
| honorificSuffix | string | ||
| id | string | ||
| idCardNo | string | ||
| idType | integer | ||
| isLocked | integer | ||
| isLockedTime | string | ||
| jobLevel | string | ||
| jobTitle | string | ||
| lastLoginIp | string | ||
| lastLoginTime | string | ||
| lastLogoffTime | string | ||
| ldapDn | string | ||
| locale | string | ||
| loginCount | integer | ||
| manager | string | ||
| managerId | string | ||
| managerType | integer | ||
| married | integer | ||
| middleName | string | ||
| mobile | string | ||
| mobileTemplateStatus | integer | ||
| mobileVerified | integer | ||
| nameZhShortSpell | string | ||
| nameZhSpell | string | ||
| nickName | string | ||
| online | integer | ||
| org | string | ||
| orgIdList | array | string | |
| orgList | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| orgNamePath | string | ||
| organization | string | ||
| orgs | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| password | string | ||
| passwordAnswer | string | ||
| passwordCycle | integer | ||
| passwordLastSetTime | string | ||
| passwordQuestion | string | ||
| passwordSetType | integer | ||
| picture | string | ||
| pictureFile | file | ||
| preferredLanguage | string | ||
| protected_apps | string | ||
| quitDate | string | ||
| randomPassword | string | ||
| roles | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| rolesIdList | array | string | |
| rolesList | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| sharedCounter | string | ||
| sharedSecret | string | ||
| sortOrder | integer | ||
| startWorkDate | string | ||
| status | integer | ||
| tenantId | string | ||
| theme | string | ||
| timeZone | string | ||
| unLockTime | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userState | string | ||
| userType | string | ||
| username | string | ||
| webSite | string | ||
| weixinFollow | integer | ||
| windowsAccount | string | ||
| workAddressFormatted | string | ||
| workCountry | string | ||
| workEmail | string | ||
| workFax | string | ||
| workLocality | string | ||
| workOfficeName | string | ||
| workPhoneNumber | string | ||
| workPostalCode | string | ||
| workRegion | string | ||
| workStreetAddress | string | ||
| userName | string | ||
| category | 应用类型(系统分类) | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| credential | 单点登录凭证类型 | integer(int32) | |
| credentials | 接口API用户凭证 | string | |
| description | 描述 | string | |
| extendAttr | 应用扩展属性 | string | |
| iconUrl | 应用图标存储地址 | string | |
| id | 应用主键 | string | |
| inducer | 引导方式 | string | |
| isAdapter | 是否支持适配器 | integer(int32) | |
| isExtendAttr | 是否支持应用扩展属性 | integer(int32) | |
| isSignature | 签名状态 | integer(int32) | |
| loginDateTime | 登录时间 | string | |
| loginUrl | 应用登录地址 | string | |
| logoutType | 单点注销方式 0 NONE,1 BACK_CHANNEL,2 FRONT_CHANNEL | integer(int32) | |
| logoutUrl | 注销地址 | string | |
| name | 应用名称 | string | |
| onlineTicket | 在线标识 | string | |
| principal | 接口API用户 | string | |
| protocol | 单点登录协议 | string | |
| secret | 应用密钥 | string | |
| sharedPassword | 共享密码 | string | |
| sharedUsername | 共享用户名 | string | |
| sortIndex | 排序序号 | integer(int32) | |
| status | 状态 | integer(int32) | |
| systemUserAttr | 系统用户属性 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userPropertys | 接口返回用户属性定义 | string | |
| vendor | 供应商 | string | |
| vendorUrl | 供应商网址 | string | |
| visible | 可见标识 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"adapter": "com.apusic.idm.v1.authz.cas.endpoint.adapter.CasDefaultAdapter",
"adapterId": "",
"adapterName": "CAS默认适配器",
"appCategory": "OAuth_v2.0",
"appCategoryStatus": 1,
"appUser": {
"appId": "",
"appName": "",
"createBy": "",
"createTime": "",
"createType": "",
"description": "",
"displayName": "",
"id": "",
"orgCast": {
"additionalProperties1": {
"code": "",
"codePath": "",
"createBy": "",
"createTime": "",
"fullName": "",
"id": "",
"name": "",
"namePath": "",
"orgId": "",
"orgParentId": "",
"parentId": "",
"parentName": "",
"provider": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": ""
}
},
"relatedPassword": "",
"relatedUserName": "",
"status": 0,
"strategyId": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userInfo": {
"adjectiveTime": "",
"appIdList": [],
"appLoginAuthnType": 0,
"appLoginPassword": "",
"appsList": [
{
"adapter": "",
"adapterId": "",
"adapterName": "",
"appCategory": "",
"appCategoryStatus": 0,
"appUser": {},
"category": "",
"createBy": "",
"createTime": "",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "",
"icon": "",
"iconFile": "",
"iconUrl": "",
"id": "",
"inducer": "",
"isAdapter": 0,
"isExtendAttr": 0,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "",
"logoutType": 0,
"logoutUrl": "",
"name": "",
"onlineTicket": "",
"principal": "",
"protocol": "",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 0,
"status": 0,
"systemUserAttr": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userPropertys": "",
"vendor": "",
"vendorUrl": "",
"visible": 0
}
],
"assistant": "",
"assistantId": "",
"authnType": 0,
"badPasswordCount": 0,
"badPasswordTime": "",
"birthDate": "",
"containsChildren": 0,
"costCenter": "",
"createBy": "",
"createTime": "",
"decipherable": "",
"defineIm": "",
"department": "",
"departmentId": "",
"description": "",
"displayName": "",
"division": "",
"email": "",
"emailTemplateStatus": 0,
"emailVerified": 0,
"employeeNumber": "",
"entryDate": "",
"expireStatus": 0,
"expireTime": "",
"extendDataList": [
{
"createBy": "",
"createTime": "",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"id": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userinfoId": ""
}
],
"extraAttribute": "",
"extraAttributeMap": {},
"extraAttributeName": "",
"extraAttributeValue": "",
"familyName": "",
"formattedName": "",
"gender": 0,
"givenName": "",
"gridList": 0,
"homeAddressFormatted": "",
"homeCountry": "",
"homeEmail": "",
"homeFax": "",
"homeLocality": "",
"homePhoneNumber": "",
"homePostalCode": "",
"homeRegion": "",
"homeStreetAddress": "",
"honorificPrefix": "",
"honorificSuffix": "",
"id": "",
"idCardNo": "",
"idType": 0,
"isLocked": 0,
"isLockedTime": "",
"jobLevel": "",
"jobTitle": "",
"lastLoginIp": "",
"lastLoginTime": "",
"lastLogoffTime": "",
"ldapDn": "",
"locale": "",
"loginCount": 0,
"manager": "",
"managerId": "",
"managerType": 0,
"married": 0,
"middleName": "",
"mobile": "",
"mobileTemplateStatus": 0,
"mobileVerified": 0,
"nameZhShortSpell": "",
"nameZhSpell": "",
"nickName": "",
"online": 0,
"org": "",
"orgIdList": [],
"orgList": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"orgNamePath": "",
"organization": "",
"orgs": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"password": "",
"passwordAnswer": "",
"passwordCycle": 0,
"passwordLastSetTime": "",
"passwordQuestion": "",
"passwordSetType": 0,
"picture": "",
"pictureFile": "",
"preferredLanguage": "",
"protected_apps": "",
"quitDate": "",
"randomPassword": "",
"roles": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"rolesIdList": [],
"rolesList": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"sharedCounter": "",
"sharedSecret": "",
"sortOrder": 0,
"startWorkDate": "",
"status": 0,
"tenantId": "",
"theme": "",
"timeZone": "",
"unLockTime": "",
"updateBy": "",
"updateTime": "",
"userState": "",
"userType": "",
"username": "",
"webSite": "",
"weixinFollow": 0,
"windowsAccount": "",
"workAddressFormatted": "",
"workCountry": "",
"workEmail": "",
"workFax": "",
"workLocality": "",
"workOfficeName": "",
"workPhoneNumber": "",
"workPostalCode": "",
"workRegion": "",
"workStreetAddress": ""
},
"userName": ""
},
"category": "HR",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "[{\"attr\":\"1\",\"type\":\"1\",\"value\":\"1\"}]",
"iconUrl": "",
"id": "0b87cc22155849f78c07a79010e42641",
"inducer": "IDP",
"isAdapter": 0,
"isExtendAttr": 1,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "http://www.apusic.com",
"logoutType": 0,
"logoutUrl": "",
"name": "招聘管理系统",
"onlineTicket": "",
"principal": "",
"protocol": "OAuth_v2.0",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 1,
"status": 0,
"systemUserAttr": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userPropertys": "userId,username,email,employeeNumber,departmentId,department,windowsAccount",
"vendor": "APUSIC",
"vendorUrl": "http://www.apusic.com",
"visible": 0
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# 停用-启用应用
接口地址:/api/apusic/v1.0/apps/{id}/{status}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---停用/启用应用信息（1是启用，0是停用）
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| status | status | path | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«App» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | App | App |
| adapter | 适配器 | string | |
| adapterId | 适配器id | string | |
| adapterName | 适配器名称 | string | |
| appCategory | 应用类型(集成应用/标准协议) | string | |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appUser | App用户 | Accounts | Accounts |
| appId | string | ||
| appName | string | ||
| createBy | string | ||
| createTime | string | ||
| createType | string | ||
| description | string | ||
| displayName | string | ||
| id | string | ||
| orgCast | OrganizationsCast | OrganizationsCast | |
| code | string | ||
| codePath | string | ||
| createBy | string | ||
| createTime | string | ||
| fullName | string | ||
| id | string | ||
| name | string | ||
| namePath | string | ||
| orgId | string | ||
| orgParentId | string | ||
| parentId | string | ||
| parentName | string | ||
| provider | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| relatedPassword | string | ||
| relatedUserName | string | ||
| status | integer | ||
| strategyId | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userId | string | ||
| userInfo | UserInfo | UserInfo | |
| adjectiveTime | string | ||
| appIdList | array | string | |
| appLoginAuthnType | integer | ||
| appLoginPassword | string | ||
| appsList | array | Apps | |
| adapter | string | ||
| adapterId | string | ||
| adapterName | string | ||
| appCategory | string | ||
| appCategoryStatus | integer | ||
| appUser | Accounts | Accounts | |
| category | string | ||
| createBy | string | ||
| createTime | string | ||
| credential | integer | ||
| credentials | string | ||
| description | string | ||
| extendAttr | string | ||
| icon | string | ||
| iconFile | file | ||
| iconUrl | string | ||
| id | string | ||
| inducer | string | ||
| isAdapter | integer | ||
| isExtendAttr | integer | ||
| isSignature | integer | ||
| loginDateTime | string | ||
| loginUrl | string | ||
| logoutType | integer | ||
| logoutUrl | string | ||
| name | string | ||
| onlineTicket | string | ||
| principal | string | ||
| protocol | string | ||
| secret | string | ||
| sharedPassword | string | ||
| sharedUsername | string | ||
| sortIndex | integer | ||
| status | integer | ||
| systemUserAttr | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userPropertys | string | ||
| vendor | string | ||
| vendorUrl | string | ||
| visible | integer | ||
| assistant | string | ||
| assistantId | string | ||
| authnType | integer | ||
| badPasswordCount | integer | ||
| badPasswordTime | string | ||
| birthDate | string | ||
| containsChildren | integer | ||
| costCenter | string | ||
| createBy | string | ||
| createTime | string | ||
| decipherable | string | ||
| defineIm | string | ||
| department | string | ||
| departmentId | string | ||
| description | string | ||
| displayName | string | ||
| division | string | ||
| string | |||
| emailTemplateStatus | integer | ||
| emailVerified | integer | ||
| employeeNumber | string | ||
| entryDate | string | ||
| expireStatus | integer | ||
| expireTime | string | ||
| extendDataList | array | UserinfoExtendAttrData | |
| createBy | string | ||
| createTime | string | ||
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| id | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userinfoId | string | ||
| extraAttribute | string | ||
| extraAttributeMap | object | ||
| extraAttributeName | string | ||
| extraAttributeValue | string | ||
| familyName | string | ||
| formattedName | string | ||
| gender | integer | ||
| givenName | string | ||
| gridList | integer | ||
| homeAddressFormatted | string | ||
| homeCountry | string | ||
| homeEmail | string | ||
| homeFax | string | ||
| homeLocality | string | ||
| homePhoneNumber | string | ||
| homePostalCode | string | ||
| homeRegion | string | ||
| homeStreetAddress | string | ||
| honorificPrefix | string | ||
| honorificSuffix | string | ||
| id | string | ||
| idCardNo | string | ||
| idType | integer | ||
| isLocked | integer | ||
| isLockedTime | string | ||
| jobLevel | string | ||
| jobTitle | string | ||
| lastLoginIp | string | ||
| lastLoginTime | string | ||
| lastLogoffTime | string | ||
| ldapDn | string | ||
| locale | string | ||
| loginCount | integer | ||
| manager | string | ||
| managerId | string | ||
| managerType | integer | ||
| married | integer | ||
| middleName | string | ||
| mobile | string | ||
| mobileTemplateStatus | integer | ||
| mobileVerified | integer | ||
| nameZhShortSpell | string | ||
| nameZhSpell | string | ||
| nickName | string | ||
| online | integer | ||
| org | string | ||
| orgIdList | array | string | |
| orgList | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| orgNamePath | string | ||
| organization | string | ||
| orgs | array | Organizations | |
| address | string | ||
| children | array | Organizations | |
| code | string | ||
| codePath | string | ||
| contact | string | ||
| country | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| division | string | ||
| string | |||
| extendId | string | ||
| fax | string | ||
| fullName | string | ||
| hasChild | string | ||
| id | string | ||
| ldapDn | string | ||
| level | integer | ||
| locality | string | ||
| name | string | ||
| namePath | string | ||
| parentId | string | ||
| parentName | string | ||
| phone | string | ||
| postalCode | string | ||
| prepositionId | string | ||
| region | string | ||
| reorgNamePath | boolean | ||
| sortIndex | integer | ||
| status | integer | ||
| street | string | ||
| tenantId | string | ||
| type | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userNum | integer | ||
| password | string | ||
| passwordAnswer | string | ||
| passwordCycle | integer | ||
| passwordLastSetTime | string | ||
| passwordQuestion | string | ||
| passwordSetType | integer | ||
| picture | string | ||
| pictureFile | file | ||
| preferredLanguage | string | ||
| protected_apps | string | ||
| quitDate | string | ||
| randomPassword | string | ||
| roles | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| rolesIdList | array | string | |
| rolesList | array | Roles | |
| authDomain | string | ||
| authDomainName | string | ||
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| id | string | ||
| isDefault | integer | ||
| name | string | ||
| orgExtendRole | integer | ||
| orgIdsList | string | ||
| rolesType | string | ||
| status | integer | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userCount | integer | ||
| username | string | ||
| sharedCounter | string | ||
| sharedSecret | string | ||
| sortOrder | integer | ||
| startWorkDate | string | ||
| status | integer | ||
| tenantId | string | ||
| theme | string | ||
| timeZone | string | ||
| unLockTime | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userState | string | ||
| userType | string | ||
| username | string | ||
| webSite | string | ||
| weixinFollow | integer | ||
| windowsAccount | string | ||
| workAddressFormatted | string | ||
| workCountry | string | ||
| workEmail | string | ||
| workFax | string | ||
| workLocality | string | ||
| workOfficeName | string | ||
| workPhoneNumber | string | ||
| workPostalCode | string | ||
| workRegion | string | ||
| workStreetAddress | string | ||
| userName | string | ||
| category | 应用类型(系统分类) | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| credential | 单点登录凭证类型 | integer(int32) | |
| credentials | 接口API用户凭证 | string | |
| description | 描述 | string | |
| extendAttr | 应用扩展属性 | string | |
| iconUrl | 应用图标存储地址 | string | |
| id | 应用主键 | string | |
| inducer | 引导方式 | string | |
| isAdapter | 是否支持适配器 | integer(int32) | |
| isExtendAttr | 是否支持应用扩展属性 | integer(int32) | |
| isSignature | 签名状态 | integer(int32) | |
| loginDateTime | 登录时间 | string | |
| loginUrl | 应用登录地址 | string | |
| logoutType | 单点注销方式 0 NONE,1 BACK_CHANNEL,2 FRONT_CHANNEL | integer(int32) | |
| logoutUrl | 注销地址 | string | |
| name | 应用名称 | string | |
| onlineTicket | 在线标识 | string | |
| principal | 接口API用户 | string | |
| protocol | 单点登录协议 | string | |
| secret | 应用密钥 | string | |
| sharedPassword | 共享密码 | string | |
| sharedUsername | 共享用户名 | string | |
| sortIndex | 排序序号 | integer(int32) | |
| status | 状态 | integer(int32) | |
| systemUserAttr | 系统用户属性 | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userPropertys | 接口返回用户属性定义 | string | |
| vendor | 供应商 | string | |
| vendorUrl | 供应商网址 | string | |
| visible | 可见标识 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"adapter": "com.apusic.idm.v1.authz.cas.endpoint.adapter.CasDefaultAdapter",
"adapterId": "",
"adapterName": "CAS默认适配器",
"appCategory": "OAuth_v2.0",
"appCategoryStatus": 1,
"appUser": {
"appId": "",
"appName": "",
"createBy": "",
"createTime": "",
"createType": "",
"description": "",
"displayName": "",
"id": "",
"orgCast": {
"additionalProperties1": {
"code": "",
"codePath": "",
"createBy": "",
"createTime": "",
"fullName": "",
"id": "",
"name": "",
"namePath": "",
"orgId": "",
"orgParentId": "",
"parentId": "",
"parentName": "",
"provider": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": ""
}
},
"relatedPassword": "",
"relatedUserName": "",
"status": 0,
"strategyId": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userInfo": {
"adjectiveTime": "",
"appIdList": [],
"appLoginAuthnType": 0,
"appLoginPassword": "",
"appsList": [
{
"adapter": "",
"adapterId": "",
"adapterName": "",
"appCategory": "",
"appCategoryStatus": 0,
"appUser": {},
"category": "",
"createBy": "",
"createTime": "",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "",
"icon": "",
"iconFile": "",
"iconUrl": "",
"id": "",
"inducer": "",
"isAdapter": 0,
"isExtendAttr": 0,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "",
"logoutType": 0,
"logoutUrl": "",
"name": "",
"onlineTicket": "",
"principal": "",
"protocol": "",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 0,
"status": 0,
"systemUserAttr": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userPropertys": "",
"vendor": "",
"vendorUrl": "",
"visible": 0
}
],
"assistant": "",
"assistantId": "",
"authnType": 0,
"badPasswordCount": 0,
"badPasswordTime": "",
"birthDate": "",
"containsChildren": 0,
"costCenter": "",
"createBy": "",
"createTime": "",
"decipherable": "",
"defineIm": "",
"department": "",
"departmentId": "",
"description": "",
"displayName": "",
"division": "",
"email": "",
"emailTemplateStatus": 0,
"emailVerified": 0,
"employeeNumber": "",
"entryDate": "",
"expireStatus": 0,
"expireTime": "",
"extendDataList": [
{
"createBy": "",
"createTime": "",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"id": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userinfoId": ""
}
],
"extraAttribute": "",
"extraAttributeMap": {},
"extraAttributeName": "",
"extraAttributeValue": "",
"familyName": "",
"formattedName": "",
"gender": 0,
"givenName": "",
"gridList": 0,
"homeAddressFormatted": "",
"homeCountry": "",
"homeEmail": "",
"homeFax": "",
"homeLocality": "",
"homePhoneNumber": "",
"homePostalCode": "",
"homeRegion": "",
"homeStreetAddress": "",
"honorificPrefix": "",
"honorificSuffix": "",
"id": "",
"idCardNo": "",
"idType": 0,
"isLocked": 0,
"isLockedTime": "",
"jobLevel": "",
"jobTitle": "",
"lastLoginIp": "",
"lastLoginTime": "",
"lastLogoffTime": "",
"ldapDn": "",
"locale": "",
"loginCount": 0,
"manager": "",
"managerId": "",
"managerType": 0,
"married": 0,
"middleName": "",
"mobile": "",
"mobileTemplateStatus": 0,
"mobileVerified": 0,
"nameZhShortSpell": "",
"nameZhSpell": "",
"nickName": "",
"online": 0,
"org": "",
"orgIdList": [],
"orgList": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"orgNamePath": "",
"organization": "",
"orgs": [
{
"address": "",
"children": [
{
"address": "",
"children": [
{}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"code": "",
"codePath": "",
"contact": "",
"country": "",
"createBy": "",
"createTime": "",
"description": "",
"division": "",
"email": "",
"extendId": "",
"fax": "",
"fullName": "",
"hasChild": "",
"id": "",
"ldapDn": "",
"level": 0,
"locality": "",
"name": "",
"namePath": "",
"parentId": "",
"parentName": "",
"phone": "",
"postalCode": "",
"prepositionId": "",
"region": "",
"reorgNamePath": true,
"sortIndex": 0,
"status": 0,
"street": "",
"tenantId": "",
"type": "",
"updateBy": "",
"updateTime": "",
"userNum": 0
}
],
"password": "",
"passwordAnswer": "",
"passwordCycle": 0,
"passwordLastSetTime": "",
"passwordQuestion": "",
"passwordSetType": 0,
"picture": "",
"pictureFile": "",
"preferredLanguage": "",
"protected_apps": "",
"quitDate": "",
"randomPassword": "",
"roles": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"rolesIdList": [],
"rolesList": [
{
"authDomain": "",
"authDomainName": "",
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"id": "",
"isDefault": 0,
"name": "",
"orgExtendRole": 0,
"orgIdsList": "",
"rolesType": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userCount": 0,
"username": ""
}
],
"sharedCounter": "",
"sharedSecret": "",
"sortOrder": 0,
"startWorkDate": "",
"status": 0,
"tenantId": "",
"theme": "",
"timeZone": "",
"unLockTime": "",
"updateBy": "",
"updateTime": "",
"userState": "",
"userType": "",
"username": "",
"webSite": "",
"weixinFollow": 0,
"windowsAccount": "",
"workAddressFormatted": "",
"workCountry": "",
"workEmail": "",
"workFax": "",
"workLocality": "",
"workOfficeName": "",
"workPhoneNumber": "",
"workPostalCode": "",
"workRegion": "",
"workStreetAddress": ""
},
"userName": ""
},
"category": "HR",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"credential": 0,
"credentials": "",
"description": "",
"extendAttr": "[{\"attr\":\"1\",\"type\":\"1\",\"value\":\"1\"}]",
"iconUrl": "",
"id": "0b87cc22155849f78c07a79010e42641",
"inducer": "IDP",
"isAdapter": 0,
"isExtendAttr": 1,
"isSignature": 0,
"loginDateTime": "",
"loginUrl": "http://www.apusic.com",
"logoutType": 0,
"logoutUrl": "",
"name": "招聘管理系统",
"onlineTicket": "",
"principal": "",
"protocol": "OAuth_v2.0",
"secret": "",
"sharedPassword": "",
"sharedUsername": "",
"sortIndex": 1,
"status": 0,
"systemUserAttr": "",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userPropertys": "userId,username,email,employeeNumber,departmentId,department,windowsAccount",
"vendor": "APUSIC",
"vendorUrl": "http://www.apusic.com",
"visible": 0
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# 1-06-字典模块
# 查询字典资源接口
接口地址:/api/apusic/v1.0/dict
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查询字典资源信息地址
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Map«string,Map»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-07-权限域接口文档模块
# 查询所有权限域接口
接口地址:/api/apusic/v1.0/domain
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询权限域信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | 应用id | query | false | string | |
| authDomainName | 权限域名称 | query | false | string | |
| id | 主键 | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| rolesName | 角色名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 新增权限域接口
接口地址:/api/apusic/v1.0/domain
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---新增权限域信息地址(租户，名称确定唯一)
请求示例:
{
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"description": "这是一个描述。。。。",
"tenantId": 5641566
}
1
2
3
4
5
6
2
3
4
5
6
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 权限域创建请求(权限域名，appId，租户id重复时注册失败) | body | true | AuthDomainCreateRequest | AuthDomainCreateRequest |
| appId | 应用id | false | string | ||
| authDomainName | 权限域名称 | false | string | ||
| description | 描述 | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«AuthDomain对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | AuthDomain对象 | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# 查询所有权限域角色接口
接口地址:/api/apusic/v1.0/domain/active
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询权限域有效角色信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | 应用id | query | false | string | |
| authDomainName | 权限域名称 | query | false | string | |
| id | 主键 | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| rolesName | 角色名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 查询该应用角色接口
接口地址:/api/apusic/v1.0/domain/app
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询该应用信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | 应用id | query | false | string | |
| authDomainName | 权限域名称 | query | false | string | |
| id | 主键 | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| rolesName | 角色名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 根据权限查询资源树
接口地址:/api/apusic/v1.0/domain/{authDomain}/resource
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---根据权限查询资源树
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| authDomain | authDomain | path | true | string | |
| resourceName | resourceName | query | false | string | |
| resourceType | resourceType | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Resources对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer(int32) | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# 通过权限域查询角色接口
接口地址:/api/apusic/v1.0/domain/{authDomain}/role
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---通过权限域查询角色地址(authDomain为权限域主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| authDomain | authDomain | path | true | string | |
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Roles对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer(int32) | |
| status | 角色状态(1为启用，0为停用) | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户数量 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 查询单个权限域接口信息
接口地址:/api/apusic/v1.0/domain/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---单个权限域信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«AuthDomain对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | AuthDomain对象 | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# 修改权限域接口
接口地址:/api/apusic/v1.0/domain/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改权限域信息地址(id为权限域的主键，实体类为修改内容)
请求示例:
{
"authDomainName": "AIDM APP",
"description": "这是一个描述。。。。"
}
1
2
3
4
2
3
4
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 权限域信息修改实体类 | body | true | AuthDomainEditRequest | AuthDomainEditRequest |
| authDomainName | 权限域名称 | false | string | ||
| description | 描述 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«AuthDomain对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | AuthDomain对象 | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# 1-08-1-用户分组模块
# 查看分组列表(支持分组名模糊搜索)
接口地址:/api/apusic/v1.0/groups
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---查看分组列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| id | 分组ID | query | false | string | |
| memberId | 用户id | query | false | string | |
| name | 分组名字(模糊查询) | query | false | string | |
| status | 状态 | query | false | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| username | 用户名/姓名(模糊查询) | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Group对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Group对象 |
| createTime | 创建日期 | string(date-time) | |
| description | 描述 | string | |
| groupMembers | 组内成员个数 | integer(int32) | |
| id | 分组ID | string | |
| name | 分组名字 | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"createTime": "",
"description": "",
"groupMembers": 0,
"id": "",
"name": "",
"tenantId": 5641566
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 创建分组
接口地址:/api/apusic/v1.0/groups
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---创建分组
请求示例:
{
"description": "",
"name": "",
"resourceIdList": [],
"tenantId": 5641566,
"userIdList": []
}
1
2
3
4
5
6
7
2
3
4
5
6
7
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupsCreateRequest | groupsCreateRequest | body | true | Groups创建对象 | Groups创建对象 |
| description | 描述 | false | string | ||
| name | 分组名字 | false | string | ||
| resourceIdList | 资源id列表 | false | array | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string | ||
| userIdList | 用户id列表 | false | array | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Groups» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Groups | Groups |
| createBy | string | ||
| createTime | string(date-time) | ||
| description | string | ||
| dynamic | string | ||
| filters | string | ||
| groupMembers | 组内成员个数 | integer(int32) | |
| id | string | ||
| isDefault | integer(int32) | ||
| name | string | ||
| orgIdsList | string | ||
| resumeTime | string | ||
| status | integer(int32) | ||
| suspendTime | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string(date-time) | ||
| username | string | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"createBy": "",
"createTime": "",
"description": "",
"dynamic": "",
"filters": "",
"groupMembers": 0,
"id": "",
"isDefault": 0,
"name": "",
"orgIdsList": "",
"resumeTime": "",
"status": 0,
"suspendTime": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"username": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 新建分组信息校验接口
接口地址:/api/apusic/v1.0/groups/name/check
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
新建分组信息校验接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupName | groupName | query | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 分组详情页面查询分组信息
接口地址:/api/apusic/v1.0/groups/{groupId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---分组详情页面查询分组信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupId | groupId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Group对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Group对象 | Group对象 |
| createTime | 创建日期 | string(date-time) | |
| description | 描述 | string | |
| groupMembers | 组内成员个数 | integer(int32) | |
| id | 分组ID | string | |
| name | 分组名字 | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"createTime": "",
"description": "",
"groupMembers": 0,
"id": "",
"name": "",
"tenantId": 5641566
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 删除分组
接口地址:/api/apusic/v1.0/groups/{groupId}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---删除分组
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupId | groupId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 修改分组信息
接口地址:/api/apusic/v1.0/groups/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---修改分组信息
请求示例:
{
"description": "",
"name": "",
"tenantId": 5641566
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | request | body | true | Group修改对象 | Group修改对象 |
| description | 描述 | false | string | ||
| name | 分组名字 | false | string | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-08-2-用户分组成员模块
# 分组详情页添加用户
接口地址:/api/apusic/v1.0/groupsMember
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---分组详情页添加用户
请求示例:
{
"groupId": "",
"userIdList": []
}
1
2
3
4
2
3
4
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupsMemberVo | groupsMemberVo | body | true | 分组用户查询对象 | 分组用户查询对象 |
| groupId | 分组id | false | string | ||
| userIdList | 要添加的用户id集合 | false | array | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询分组下未选中用户接口
接口地址:/api/apusic/v1.0/groupsMember/unuser
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询分组下未选中用户接口（id为分组主键id,tenantId租户,username用户姓名/用户名(模糊查询)）
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| id | 分组ID | query | false | string | |
| memberId | 用户id | query | false | string | |
| name | 分组名字(模糊查询) | query | false | string | |
| status | 状态 | query | false | integer(int32) | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| username | 用户名/姓名(模糊查询) | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 为某用户批量添加分组
接口地址:/api/apusic/v1.0/groupsMember/userInfosGroup
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---为某用户批量添加分组
请求示例:
{
"groupIdList": [],
"userInfosId": ""
}
1
2
3
4
2
3
4
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | request | body | true | GroupsMember创建对象 | GroupsMember创建对象 |
| groupIdList | 分组id列表 | false | array | string | |
| userInfosId | 描述 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除用户下的单个分组
接口地址:/api/apusic/v1.0/groupsMember/userInfosGroup/{groupMemberId}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---删除用户下的单个分组（tenantId租户）
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupMemberId | groupMemberId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询用户(模糊搜索)下未选中的分组接口
接口地址:/api/apusic/v1.0/groupsMember/userInfosGroup/{userInfosId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---查询用户下未选中的分组接口，memberId是用户id
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| userInfosId | userInfosId | path | true | string | |
| groupName | groupName | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Group对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Group对象 |
| createTime | 创建日期 | string(date-time) | |
| description | 描述 | string | |
| groupMembers | 组内成员个数 | integer(int32) | |
| id | 分组ID | string | |
| name | 分组名字 | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"createTime": "",
"description": "",
"groupMembers": 0,
"id": "",
"name": "",
"tenantId": 5641566
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 分组详情页面查询用户信息
接口地址:/api/apusic/v1.0/groupsMember/{groupId}/user
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---分组详情页面查询用户信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupId | groupId | path | true | string | |
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 分组详情页删除用户
接口地址:/api/apusic/v1.0/groupsMember/{groupId}/{userInfoId}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---分组详情页删除用户
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupId | groupId | path | true | string | |
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询用户下的所有分组信息
接口地址:/api/apusic/v1.0/groupsMember/{userInfosId}/userInfoGroup
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---查询用户下的所有分组信息（id为分组主键id,tenantId租户）
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| userInfosId | userInfosId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfosGroupsVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfosGroupsVO |
| description | string | ||
| groupId | string | ||
| groupName | string | ||
| id | string | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"description": "",
"groupId": "",
"groupName": "",
"id": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 1-08-3-用户分组资源模块
# 查询(模糊查询)分组下未选中资源接口
接口地址:/api/apusic/v1.0/groupResources/groups/unresource
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---查询分组下未选中资源接口(),2:租户id(不填则默认为0),3:资源名(选填,模糊查询))
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authDomain | 权限人 | query | false | string | |
| groupId | 分组id | query | false | string | |
| id | id | query | false | string | |
| name | 资源名称 | query | false | string | |
| resourceIdList | 资源id集合 | query | false | array | string |
| resourceType | 资源类型 | query | false | string | |
| rolesId | 角色id | query | false | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | query | false | string | |
| userInfoId | 用户id | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 将资源批量分配给分组
接口地址:/api/apusic/v1.0/groupResources/groupsResource
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
赵禹---将资源批量分配给分组
请求示例:
{
"authDomain": "",
"groupId": "",
"id": "",
"name": "",
"resourceIdList": [],
"resourceType": "",
"rolesId": "",
"tenantId": "",
"userInfoId": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourcesQueryFilter | resourcesQueryFilter | body | true | Resources查询对象 | Resources查询对象 |
| authDomain | 权限人 | false | string | ||
| groupId | 分组id | false | string | ||
| id | id | false | string | ||
| name | 资源名称 | false | string | ||
| resourceIdList | 资源id集合 | false | array | string | |
| resourceType | 资源类型 | false | string | ||
| rolesId | 角色id | false | string | ||
| tenantId | 租户id（选择的权限域中的域名,默认为0） | false | string | ||
| userInfoId | 用户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查看分组下的资源
接口地址:/api/apusic/v1.0/groupResources/{groupId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---查看分组下的资源
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupId | groupId | path | true | string | |
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«ResourceUserInfoVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | ResourceUserInfoVO |
| authDomainId | string | ||
| authDomainName | 权限分组名称 | string | |
| children | 子节点 | array | ResourceUserInfoVO |
| createTime | 创建时间 | string(date-time) | |
| description | string | ||
| id | id | string | |
| level | integer(int32) | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceType | 资源类型 | string | |
| sortIndex | 排序 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 删除分组下的资源
接口地址:/api/apusic/v1.0/groupResources/{groupId}/{resourceId}/groupsResource
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
赵禹---删除分组下的资源
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| groupId | groupId | path | true | string | |
| resourceId | resourceId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-09-登录接口文档模块
# 登录接口
接口地址:/api/apusic/v1.0/login
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---登录接口
请求示例:
{
"authType": "normal:tfa:mobile",
"captcha": "2uUv",
"ignoreCaptcha": 0,
"password": "zhangsan",
"sessionId": "C954E47D8726E7714D7F5607935F8BFB",
"username": "zhangsan"
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| loginRequest | 登录请求类 | body | true | LoginRequest | LoginRequest |
| authType | 登录类型 | true | string | ||
| captcha | 验证码 | true | string | ||
| ignoreCaptcha | 是否忽略验证码（0-不忽略/1-忽略）,默认不忽略 | false | integer(int32) | ||
| password | 密码 | true | string | ||
| sessionId | 会话id | true | string | ||
| username | 用户名（唯一） | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«LoginReturnVO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | LoginReturnVO | LoginReturnVO |
| displayName | 姓名 | string | |
| id | 编号 | string | |
| initialFixStatus | 首次登陆强制修改密码(1为是,0为否) | integer(int32) | |
| lastLoginTime | 最近一次登录时间 | string | |
| managerType | 管理员标识（0为否，1为是） | integer(int32) | |
| passwordCycle | 密码到期强制修改密码(1为是,0为否) | integer(int32) | |
| passwordSetType | 登录类型(1为首次登录,3为密码过期[校验passwordCycle],4为未登录但管理员修改密码) | integer(int32) | |
| picture | 用户图像URL | string | |
| token | token信息 | Token | Token |
| accessToken | 访问令牌 | string | |
| expireIn | 访问令牌的有效期 | integer | |
| refreshExpireIn | 刷新令牌的有效期 | integer | |
| refreshToken | 刷新令牌 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"displayName": "张三",
"id": 593887578604699648,
"initialFixStatus": 0,
"lastLoginTime": "2021-12-12 14:26:22",
"managerType": 1,
"passwordCycle": 0,
"passwordSetType": 0,
"picture": "http://localhost:9000",
"token": {
"accessToken": "",
"expireIn": 30000,
"refreshExpireIn": 60000,
"refreshToken": ""
},
"username": "zhangsan"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# 手机短信验证码发送接口
接口地址:/api/apusic/v1.0/login/sendsms/{mobile}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---手机短信验证码发送接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| mobile | 手机号 | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 注销接口
接口地址:/api/apusic/v1.0/logout-success
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---注销接口
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 重定向登录接口
接口地址:/api/apusic/v1.0/relogin
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---重定向登录接口
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-10-菜单接口文档模块
# 根据用户id查询菜单信息
接口地址:/api/apusic/v1.0/menu/{userInfoId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---根据用户id查询菜单信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| userInfoId | userInfoId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«MenuReturnVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | MenuReturnVO |
| icon | 图标 | string | |
| id | 菜单资源的id | string | |
| key | 访问url | string | |
| sortIndex | 菜单排序 | integer(int32) | |
| subs | 子菜单 | array | MenuReturnVO |
| title | 菜单名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"icon": "appstore",
"id": "aidm:menu:application",
"key": "/application",
"sortIndex": 1,
"subs": "[]",
"title": "应用管理"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 1-11-组织接口文档模块
# 根据父节点查询下一级子节点列表
接口地址:/api/apusic/v1.0/orgs/children
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---根据父节点查询下一级子节点列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| parentId | parentId | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«OrgVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# excel导出
接口地址:/api/apusic/v1.0/orgs/excel/error/{uuid}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---组织机构导出
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| uuid | uuid | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# excel导入
接口地址:/api/apusic/v1.0/orgs/excel/read
请求方式:POST
请求数据类型:multipart/form-data
响应数据类型:application/json
接口描述:
吴昌达---组织机构导入
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| file | file | body | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 组织模板
接口地址:/api/apusic/v1.0/orgs/excel/template
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---下载组织机构导入模板
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 组织树模糊搜索
接口地址:/api/apusic/v1.0/orgs/fuzzy
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---输入组织机构名查询，如果输入为空则返回全部组织树
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| name | name | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«OrgVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# 查询组织树
接口地址:/api/apusic/v1.0/orgs/tree
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查询组织树，输入不同的租户id切换组织树
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«OrgVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# 补全组织树信息
接口地址:/api/apusic/v1.0/orgs/tree/fullData
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---补全组织树信息
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«OrgVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# 查询某结点
接口地址:/api/apusic/v1.0/orgs/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查询某一个结点 必填项:id
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OrgVO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OrgVO | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 修改结点信息
接口地址:/api/apusic/v1.0/orgs/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---修改某一结点的信息 必填项:id
请求示例:
{
"description": "",
"name": "",
"tenantId": ""
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| orgEditRequest | 组织修改请求 | body | true | OrgEditRequest | OrgEditRequest |
| description | 组织描述 | false | string | ||
| name | 组织名称 | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OrgVO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OrgVO | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 删除结点
接口地址:/api/apusic/v1.0/orgs/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---删除某一结点 必填项:id
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OrgVO» |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OrgVO | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 添加子结点
接口地址:/api/apusic/v1.0/orgs/{id}/child
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---向某一父结点添加子结点 必填项:id(父结点id) request.name(子结点名称)
请求示例:
{
"description": "",
"name": "",
"parentId": "",
"sortIndex": 0,
"tenantId": ""
}
1
2
3
4
5
6
7
2
3
4
5
6
7
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 组织创建请求 | body | true | OrgCreateRequest | OrgCreateRequest |
| description | 组织描述 | false | string | ||
| name | 组织名称 | false | string | ||
| parentId | 父结点 | false | string | ||
| sortIndex | 排序编号 | false | integer(int32) | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OrgVO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OrgVO | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 变更结点
接口地址:/api/apusic/v1.0/orgs/{id}/replace
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---将一个部门转移到另一个部门下 必填项:id(新部门的id) orgReplaceRequest.id(需要转移的部门的id) orgReplaceRequest.parentId(需要转移的部门的原父结点id)
请求示例:
{
"id": "",
"name": "",
"parentId": "",
"prepositionId": "",
"tenantId": ""
}
1
2
3
4
5
6
7
2
3
4
5
6
7
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| orgReplaceRequest | 组织变更请求 | body | true | OrgReplaceRequest | OrgReplaceRequest |
| id | 组织主键 | false | string | ||
| name | 组织名称 | false | string | ||
| parentId | 父结点 | false | string | ||
| prepositionId | 前驱结点 | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OrgVO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OrgVO | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 1-12-oauth20协议接入模块
# 添加应用
接口地址:/api/apusic/v1.0/oauth20
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---添加应用
请求示例:
{
"accessTokenValiditySeconds": 7200,
"additionalInformation": "{\"email\":\"18947539527\"}",
"authorizedGrantTypes": "authorization_code/implicit",
"description": "gitlab",
"iconUrl": "/aidm/pic/5646.jpg",
"id": 15684564666854,
"idTokenValidity": 3600,
"loginUrl": "http://localhost:9527",
"name": "gitlab",
"protocol": "OAuth_v2.0/OAuth_v2.1/OpenID_Connect_v1.0/Form_Based/CAS",
"refreshTokenValiditySeconds": 3600,
"registeredRedirectUris": "http://localhost:9005",
"tenantId": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | AUTH20协议创建请求类 | body | true | OAuth20CreateRequest | OAuth20CreateRequest |
| accessTokenValiditySeconds | accesstoken有效时间 | false | integer(int32) | ||
| additionalInformation | claim信息 | false | string | ||
| authorizedGrantTypes | 认证类型 | false | string | ||
| description | 应用描述 | false | string | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| idTokenValidity | idToken有效时间 | false | integer(int32) | ||
| loginUrl | 登录url | false | string | ||
| name | 应用名称 | false | string | ||
| protocol | 协议名 | false | string | ||
| refreshTokenValiditySeconds | refreshToken有效时间 | false | integer(int32) | ||
| registeredRedirectUris | 重定向url | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 添加OIDC应用
接口地址:/api/apusic/v1.0/oauth20/oidc
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---添加应用
请求示例:
{
"accessTokenValiditySeconds": 7200,
"additionalInformation": "{\"email\":\"18947539527\"}",
"authorizedGrantTypes": "authorization_code/implicit",
"description": "gitlab",
"iconUrl": "/aidm/pic/5646.jpg",
"id": 15684564666854,
"idTokenValidity": 3600,
"loginUrl": "http://localhost:9527",
"name": "gitlab",
"protocol": "OAuth_v2.0/OAuth_v2.1/OpenID_Connect_v1.0/Form_Based/CAS",
"refreshTokenValiditySeconds": 3600,
"registeredRedirectUris": "http://localhost:9005",
"tenantId": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | AUTH20协议创建请求类 | body | true | OAuth20CreateRequest | OAuth20CreateRequest |
| accessTokenValiditySeconds | accesstoken有效时间 | false | integer(int32) | ||
| additionalInformation | claim信息 | false | string | ||
| authorizedGrantTypes | 认证类型 | false | string | ||
| description | 应用描述 | false | string | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| idTokenValidity | idToken有效时间 | false | integer(int32) | ||
| loginUrl | 登录url | false | string | ||
| name | 应用名称 | false | string | ||
| protocol | 协议名 | false | string | ||
| refreshTokenValiditySeconds | refreshToken有效时间 | false | integer(int32) | ||
| registeredRedirectUris | 重定向url | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 根据clientId更新OIDC应用信息
接口地址:/api/apusic/v1.0/oauth20/oidc/{clientId}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---根据id更新OIDC应用信息
请求示例:
{
"accessTokenValiditySeconds": 7200,
"additionalInformation": "{\"email\":\"18947539527\"}",
"authorizedGrantTypes": "authorization_code/implicit",
"description": "gitlab",
"iconUrl": "http://localhost:9000",
"id": 15684564666854,
"idTokenValidity": 3600,
"loginUrl": "http://localhost:9527",
"name": "gitlab",
"refreshTokenValiditySeconds": 3600,
"registeredRedirectUris": "http://localhost:10012"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| clientId | clientId | path | true | string | |
| oAuth20EditRequest | AUTH20协议编辑请求类 | body | true | OAuth20EditRequest | OAuth20EditRequest |
| accessTokenValiditySeconds | accesstoken有效时间 | false | integer(int32) | ||
| additionalInformation | claim信息 | false | string | ||
| authorizedGrantTypes | 认证类型 | false | string | ||
| description | 应用描述 | false | string | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| idTokenValidity | idToken有效时间 | false | integer(int32) | ||
| loginUrl | 登录url | false | string | ||
| name | 应用名称 | false | string | ||
| refreshTokenValiditySeconds | refreshToken有效时间 | false | integer(int32) | ||
| registeredRedirectUris | 重定向跳转url | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 根据clientId查询应用信息
接口地址:/api/apusic/v1.0/oauth20/{clientId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---根据clientId查询应用信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| clientId | clientId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OAuth20DetailsShowVO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OAuth20DetailsShowVO | OAuth20DetailsShowVO |
| accessTokenValidity | accessToken有效时间 | integer(int32) | |
| appId | 应用ID | string | |
| appName | 应用名称 | string | |
| authorizedGrantTypes | 认证类型 | string | |
| claimInformation | claim信息 | array | KeyValue |
| key | string | ||
| value | object | ||
| clientSecret | 秘钥 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 应用描述 | string | |
| iconUrl | icon url | string | |
| idTokenValidity | idToken有效时间 | integer(int32) | |
| loginUrl | 登录url | string | |
| refreshTokenValidity | refreshToken有效时间 | integer(int32) | |
| webServerRedirectUri | 重定向url | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"accessTokenValidity": 7200,
"appId": 15684564666854,
"appName": "gitlab",
"authorizedGrantTypes": "authorization_code/implicit",
"claimInformation": "[{\"key\":\"email\"},{\"value\":\"邮箱\"}]",
"clientSecret": "b3lvMTEwMjIwMjIxNDE5NTY4NDIxZj",
"createTime": "2022-01-01 12:00:00",
"description": "gitlab",
"iconUrl": "http://localhost:9000",
"idTokenValidity": 3600,
"loginUrl": "https://localhost:9999",
"refreshTokenValidity": 3600,
"webServerRedirectUri": "https://localhost:9999"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# 根据clientId更新应用信息
接口地址:/api/apusic/v1.0/oauth20/{clientId}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---根据id更新应用信息
请求示例:
{
"accessTokenValiditySeconds": 7200,
"additionalInformation": "{\"email\":\"18947539527\"}",
"authorizedGrantTypes": "authorization_code/implicit",
"description": "gitlab",
"iconUrl": "http://localhost:9000",
"id": 15684564666854,
"idTokenValidity": 3600,
"loginUrl": "http://localhost:9527",
"name": "gitlab",
"refreshTokenValiditySeconds": 3600,
"registeredRedirectUris": "http://localhost:10012"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| clientId | clientId | path | true | string | |
| oAuth20EditRequest | AUTH20协议编辑请求类 | body | true | OAuth20EditRequest | OAuth20EditRequest |
| accessTokenValiditySeconds | accesstoken有效时间 | false | integer(int32) | ||
| additionalInformation | claim信息 | false | string | ||
| authorizedGrantTypes | 认证类型 | false | string | ||
| description | 应用描述 | false | string | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| idTokenValidity | idToken有效时间 | false | integer(int32) | ||
| loginUrl | 登录url | false | string | ||
| name | 应用名称 | false | string | ||
| refreshTokenValiditySeconds | refreshToken有效时间 | false | integer(int32) | ||
| registeredRedirectUris | 重定向跳转url | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-13-文件上传模块
# 上传文件接口
接口地址:/api/apusic/v1.0/minio/upload
请求方式:POST
请求数据类型:multipart/form-data
响应数据类型:application/json
接口描述:
肖清---上传文件接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| file | 文件 | body | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-14-1-密码策略文档模块
# 查询密码策略接口
接口地址:/api/apusic/v1.0/passwordpolicy
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询密码策略地址
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«PassWordVO对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | PassWordVO对象 | PassWordVO对象 |
| passwordNoticeVOList | 主键 | array | PasswordNoticeVO对象 |
| check | 是否选中(0为未选中,1为选中) | boolean | |
| code | 编码 | string | |
| description | 描述 | string | |
| id | 主键 | string | |
| name | 名称 | string | |
| passwordPolicyVO | 主键 | PasswordPolicy对象 | PasswordPolicy对象 |
| attempts | 登录尝试次数 | integer | |
| attemptsTime | 密码尝试时间范围(分钟) | integer | |
| digits | 包含数字 | integer | |
| duration | 自动解除（时间：分钟） | integer | |
| expiration | 过期时间（时间：天） | integer | |
| id | 主键 | string | |
| initialFixStatus | 首次登陆是否要强制修改密码 | integer | |
| lowerCase | 包含小写字母 | integer | |
| maxLength | 最大长度 | integer | |
| minLength | 最小长度 | integer | |
| specialChar | 特殊字符 | integer | |
| upperCase | 包含大写字母 | integer | |
| wrongPasswordCheck | 错误密码开启锁定 | integer | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"passwordNoticeVOList": [
{
"check": false,
"code": "MANAGER_INSERT",
"description": ".........",
"id": "0b87cc22155849f78c07a79010e42641",
"name": "管理员使用excel导入用户"
}
],
"passwordPolicyVO": {
"attempts": 3,
"attemptsTime": 30,
"digits": 1,
"duration": 3,
"expiration": 90,
"id": "0b87cc22155849f78c07a79010e42641",
"initialFixStatus": 1,
"lowerCase": 1,
"maxLength": 20,
"minLength": 6,
"specialChar": 1,
"upperCase": 1,
"wrongPasswordCheck": false
}
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# 校验密码策略接口
接口地址:/api/apusic/v1.0/passwordpolicy/password
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---校验密码策略信息地址
请求示例:
{
"attempts": 3,
"attemptsTime": 90,
"digits": 1,
"duration": 30,
"expiration": 90,
"initialFixStatus": 1,
"lowerCase": 1,
"maxLength": 20,
"minLength": 6,
"password": "Aa1234",
"passwordNoticeEditRequestList": [
{
"emailStatus": 0,
"id": 1564576617258,
"smsStatus": 0
}
],
"specialChar": 1,
"upperCase": 1
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 密码策略信息修改实体类 | body | true | PasswordPolicyEditRequest | PasswordPolicyEditRequest |
| attempts | 登录尝试次数 | false | integer(int32) | ||
| attemptsTime | 密码尝试时间范围(分钟) | false | integer(int32) | ||
| digits | 包含数字 | false | integer(int32) | ||
| duration | 自动解除（时间：分钟） | false | integer(int32) | ||
| expiration | 过期时间（时间：天） | false | integer(int32) | ||
| initialFixStatus | 首次登陆是否强制修改密码 | false | integer(int32) | ||
| lowerCase | 包含小写字母 | false | integer(int32) | ||
| maxLength | 最大长度 | false | integer(int32) | ||
| minLength | 最小长度 | false | integer(int32) | ||
| password | 密码 | false | string | ||
| passwordNoticeEditRequestList | 密码通知 | false | array | PasswordNoticeEditRequest | |
| emailStatus | 是否通过邮件发送邮件通知 | false | integer | ||
| id | id | false | string | ||
| smsStatus | 是否通过手机发送短信通知 | false | integer | ||
| specialChar | 特殊字符 | false | integer(int32) | ||
| upperCase | 包含大写字母 | false | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 随机生成符合密码策略的接口
接口地址:/api/apusic/v1.0/passwordpolicy/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---随机生成符合密码策略的接口地址(id为用户主键id)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 修改密码策略接口
接口地址:/api/apusic/v1.0/passwordpolicy/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---修改密码策略接口信息地址
请求示例:
{
"attempts": 3,
"attemptsTime": 90,
"digits": 1,
"duration": 30,
"expiration": 90,
"initialFixStatus": 1,
"lowerCase": 1,
"maxLength": 20,
"minLength": 6,
"password": "Aa1234",
"passwordNoticeEditRequestList": [
{
"emailStatus": 0,
"id": 1564576617258,
"smsStatus": 0
}
],
"specialChar": 1,
"upperCase": 1
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| editRequest | 密码策略信息修改实体类 | body | true | PasswordPolicyEditRequest | PasswordPolicyEditRequest |
| attempts | 登录尝试次数 | false | integer(int32) | ||
| attemptsTime | 密码尝试时间范围(分钟) | false | integer(int32) | ||
| digits | 包含数字 | false | integer(int32) | ||
| duration | 自动解除（时间：分钟） | false | integer(int32) | ||
| expiration | 过期时间（时间：天） | false | integer(int32) | ||
| initialFixStatus | 首次登陆是否强制修改密码 | false | integer(int32) | ||
| lowerCase | 包含小写字母 | false | integer(int32) | ||
| maxLength | 最大长度 | false | integer(int32) | ||
| minLength | 最小长度 | false | integer(int32) | ||
| password | 密码 | false | string | ||
| passwordNoticeEditRequestList | 密码通知 | false | array | PasswordNoticeEditRequest | |
| emailStatus | 是否通过邮件发送邮件通知 | false | integer | ||
| id | id | false | string | ||
| smsStatus | 是否通过手机发送短信通知 | false | integer | ||
| specialChar | 特殊字符 | false | integer(int32) | ||
| upperCase | 包含大写字母 | false | integer(int32) | ||
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«PasswordPolicy对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | PasswordPolicy对象 | PasswordPolicy对象 |
| attempts | 登录尝试次数 | integer(int32) | |
| attemptsTime | 密码尝试时间范围(分钟) | integer(int32) | |
| digits | 包含数字 | integer(int32) | |
| duration | 自动解除（时间：分钟） | integer(int32) | |
| expiration | 过期时间（时间：天） | integer(int32) | |
| id | 主键 | string | |
| initialFixStatus | 首次登陆是否要强制修改密码 | integer(int32) | |
| lowerCase | 包含小写字母 | integer(int32) | |
| maxLength | 最大长度 | integer(int32) | |
| minLength | 最小长度 | integer(int32) | |
| specialChar | 特殊字符 | integer(int32) | |
| upperCase | 包含大写字母 | integer(int32) | |
| wrongPasswordCheck | 错误密码开启锁定 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"attempts": 3,
"attemptsTime": 30,
"digits": 1,
"duration": 3,
"expiration": 90,
"id": "0b87cc22155849f78c07a79010e42641",
"initialFixStatus": 1,
"lowerCase": 1,
"maxLength": 20,
"minLength": 6,
"specialChar": 1,
"upperCase": 1,
"wrongPasswordCheck": false
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# 1-14-2-密码通知文档模块
# 查询密码通知接口
接口地址:/api/apusic/v1.0/password_notice
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询密码通知信息地址
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«PasswordNoticeVO对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | PasswordNoticeVO对象 |
| check | 是否选中(0为未选中,1为选中) | boolean | |
| code | 编码 | string | |
| description | 描述 | string | |
| id | 主键 | string | |
| name | 名称 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"check": false,
"code": "MANAGER_INSERT",
"description": ".........",
"id": "0b87cc22155849f78c07a79010e42641",
"name": "管理员使用excel导入用户"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 1-15-组织用户关系接口文档模块
# 移除组织架构中人员
接口地址:/api/apusic/v1.0/org_user
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---移除部门中的用户 必填项:orgId(组织id) memberId(用户id)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| memberId | 用户主键 | query | false | string | |
| orgId | 组织主键 | query | false | string | |
| tenantId | 租户id | query | false | string | |
| type | 类型 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 人员转岗
接口地址:/api/apusic/v1.0/org_user/change
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---将一个部门下的用户转移到另一个部门 必填项:newOrgId(新组织的id) orgId(原组织id) memberId(用户id)
请求示例:
{
"newOrgId": "",
"requestList": [
{
"memberId": "",
"orgId": "",
"tenantId": ""
}
]
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 用户转岗请求 | body | true | OrgMemberChangeRequest | OrgMemberChangeRequest |
| newOrgId | 新组织主键 | false | string | ||
| requestList | 组织用户创建请求列表 | false | array | OrgMemberCreateRequest | |
| memberId | 用户主键 | false | string | ||
| orgId | 组织主键 | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OrgUserInfoVO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OrgUserInfoVO | OrgUserInfoVO |
| memberId | 用户主键 | string | |
| orgId | 组织主键 | string | |
| tenantId | 租户id | string | |
| type | 类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"memberId": "",
"orgId": "",
"tenantId": "",
"type": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 添加人员
接口地址:/api/apusic/v1.0/org_user/user
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---添加组织用户关系 必填项:orgId(组织id) memberId(用户id)
请求示例:
[
{
"memberId": "",
"orgId": "",
"tenantId": ""
}
]
1
2
3
4
5
6
7
2
3
4
5
6
7
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| requestList | 组织用户关系创建请求 | body | true | array | OrgMemberCreateRequest |
| memberId | 用户主键 | false | string | ||
| orgId | 组织主键 | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«OrgUserInfoVO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | OrgUserInfoVO | OrgUserInfoVO |
| memberId | 用户主键 | string | |
| orgId | 组织主键 | string | |
| tenantId | 租户id | string | |
| type | 类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"memberId": "",
"orgId": "",
"tenantId": "",
"type": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 1-16-用户账号模块
# 查询账号列表接口
接口地址:/api/apusic/v1.0/account
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询账号列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appName | 应用名称 | query | false | string | |
| userId | 用户id | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Account对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Account对象 |
| appId | 应用id | string | |
| appName | 应用名称 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createType | 创建类型 | string | |
| description | 备注 | string | |
| displayName | 用户中文名 | string | |
| id | 主键 | string | |
| relatedPassword | 应用密码 | string | |
| relatedUserName | 应用账号名 | string | |
| status | 状态 | integer(int32) | |
| strategyId | 策略id | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userId | 用户主键 | string | |
| userName | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appId": "0b87cc22155849f78c07a79010e42641",
"appName": "gitlab",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createType": "",
"description": "备注............",
"displayName": "张三",
"id": "0b87cc22155849f78c07a79010e42641",
"relatedPassword": "Aa123!",
"relatedUserName": "zhangsan",
"status": 1,
"strategyId": "0b87cc22155849f78c07a79010e42641",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userId": "0b87cc22155849f78c07a79010e42641",
"userName": "zhangsan"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 新增账号接口
接口地址:/api/apusic/v1.0/account
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---新增账号(子账号,必传)
请求示例:
{
"appId": "0b87cc22155849f78c07a79010e42641",
"appName": "gitlab",
"clickSourceStatus": 1,
"createType": "",
"description": "备注............",
"displayName": "张三",
"relatedPassword": "Aa123!",
"relatedUserName": "zhangsan",
"status": 1,
"userId": "0b87cc22155849f78c07a79010e42641",
"userName": "zhangsan"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 账户创建请求 | body | true | AccountsCreateRequest | AccountsCreateRequest |
| appId | 应用id | false | string | ||
| appName | 应用名称 | false | string | ||
| clickSourceStatus | 来源(个人中心:0,单点登录应用配置:1) | false | integer(int32) | ||
| createType | 创建类型 | false | string | ||
| description | 备注 | false | string | ||
| displayName | 用户中文名 | false | string | ||
| relatedPassword | 应用密码 | false | string | ||
| relatedUserName | 应用账号名 | false | string | ||
| status | 状态 | false | integer(int32) | ||
| userId | 用户主键 | false | string | ||
| userName | 用户名 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Account对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Account对象 | Account对象 |
| appId | 应用id | string | |
| appName | 应用名称 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createType | 创建类型 | string | |
| description | 备注 | string | |
| displayName | 用户中文名 | string | |
| id | 主键 | string | |
| relatedPassword | 应用密码 | string | |
| relatedUserName | 应用账号名 | string | |
| status | 状态 | integer(int32) | |
| strategyId | 策略id | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userId | 用户主键 | string | |
| userName | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appId": "0b87cc22155849f78c07a79010e42641",
"appName": "gitlab",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createType": "",
"description": "备注............",
"displayName": "张三",
"id": "0b87cc22155849f78c07a79010e42641",
"relatedPassword": "Aa123!",
"relatedUserName": "zhangsan",
"status": 1,
"strategyId": "0b87cc22155849f78c07a79010e42641",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userId": "0b87cc22155849f78c07a79010e42641",
"userName": "zhangsan"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 查询某应用下子账号列表接口
接口地址:/api/apusic/v1.0/account/apps
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询某应用下子账号列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | 应用id | query | false | string | |
| relatedUserName | 子账号名称 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Account对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Account对象 |
| appId | 应用id | string | |
| appName | 应用名称 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createType | 创建类型 | string | |
| description | 备注 | string | |
| displayName | 用户中文名 | string | |
| id | 主键 | string | |
| relatedPassword | 应用密码 | string | |
| relatedUserName | 应用账号名 | string | |
| status | 状态 | integer(int32) | |
| strategyId | 策略id | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userId | 用户主键 | string | |
| userName | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appId": "0b87cc22155849f78c07a79010e42641",
"appName": "gitlab",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createType": "",
"description": "备注............",
"displayName": "张三",
"id": "0b87cc22155849f78c07a79010e42641",
"relatedPassword": "Aa123!",
"relatedUserName": "zhangsan",
"status": 1,
"strategyId": "0b87cc22155849f78c07a79010e42641",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userId": "0b87cc22155849f78c07a79010e42641",
"userName": "zhangsan"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 子账号错误信息下载
接口地址:/api/apusic/v1.0/account/excel/error/{uuid}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---子账号错误信息下载
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| uuid | uuid | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# excel导入
接口地址:/api/apusic/v1.0/account/excel/read
请求方式:POST
请求数据类型:multipart/form-data
响应数据类型:application/json
接口描述:
潘文竹---导入子账户
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| file | file | body | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 子账号模板
接口地址:/api/apusic/v1.0/account/excel/template
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---子账号模板
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除账号列表接口
接口地址:/api/apusic/v1.0/account/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---删除账号列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appId | 应用id | query | true | string | |
| id | id | path | true | string | |
| relatedUserName | 应用账号名 | query | true | string | |
| userName | 用户名 | query | true | string | |
| appName | 应用名称 | query | false | string | |
| clickSourceStatus | 来源(个人中心:0,单点登录应用配置:1) | query | false | integer(int32) | |
| createType | 创建类型 | query | false | string | |
| description | 备注 | query | false | string | |
| displayName | 用户中文名 | query | false | string | |
| relatedPassword | 应用密码 | query | false | string | |
| status | 状态 | query | false | integer(int32) | |
| userId | 用户主键 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Account对象» |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Account对象 | Account对象 |
| appId | 应用id | string | |
| appName | 应用名称 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| createType | 创建类型 | string | |
| description | 备注 | string | |
| displayName | 用户中文名 | string | |
| id | 主键 | string | |
| relatedPassword | 应用密码 | string | |
| relatedUserName | 应用账号名 | string | |
| status | 状态 | integer(int32) | |
| strategyId | 策略id | string | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userId | 用户主键 | string | |
| userName | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appId": "0b87cc22155849f78c07a79010e42641",
"appName": "gitlab",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createType": "",
"description": "备注............",
"displayName": "张三",
"id": "0b87cc22155849f78c07a79010e42641",
"relatedPassword": "Aa123!",
"relatedUserName": "zhangsan",
"status": 1,
"strategyId": "0b87cc22155849f78c07a79010e42641",
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userId": "0b87cc22155849f78c07a79010e42641",
"userName": "zhangsan"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 1-17-授权接口文档模块
# 查看详情
接口地址:/api/apusic/v1.0/permissions
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查看详情 必填项:授权id(permissionsId)，资源id(authId)，和类型(type)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authId | 6353654 | query | false | string | |
| permissionsId | 254235843643 | query | false | string | |
| type | USER | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«ResourceUserInfoVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | ResourceUserInfoVO |
| authDomainId | string | ||
| authDomainName | 权限分组名称 | string | |
| children | 子节点 | array | ResourceUserInfoVO |
| createTime | 创建时间 | string(date-time) | |
| description | string | ||
| id | id | string | |
| level | integer(int32) | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceType | 资源类型 | string | |
| sortIndex | 排序 | integer(int32) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{
"authDomainId": "",
"authDomainName": "",
"children": [
{}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"createTime": "",
"description": "",
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceType": "",
"sortIndex": 0
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 添加授权
接口地址:/api/apusic/v1.0/permissions
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
吴昌达---将资源授权出去 均为必填项 permissionsId(可以是roleId、userInfoId等) type(类型暂时只有用户(USER)、角色(ROLE))
请求示例:
{
"appIdList": [],
"isPermit": 0,
"permissionsIdList": [],
"resourceIdList": [],
"status": 0,
"tenantId": "",
"type": ""
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| req | req | body | true | PermissionsCreateRequestList | PermissionsCreateRequestList |
| appIdList | appId列表 | false | array | string | |
| isPermit | 是否允许使用 | false | integer(int32) | ||
| permissionsIdList | 被授权的id列表 | false | array | string | |
| resourceIdList | resourceId列表 | false | array | string | |
| status | 状态 | false | integer(int32) | ||
| tenantId | 租户id | false | string | ||
| type | 类型 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 应用查看授权
接口地址:/api/apusic/v1.0/permissions/app
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---查看应用下授权 必填项:appId(应用Id), isPermit 1代表允许 0代表拒绝
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | query | false | string | ||
| authId | query | false | string | ||
| groupName | query | false | string | ||
| orgName | query | false | string | ||
| type | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除应用授权
接口地址:/api/apusic/v1.0/permissions/app
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---删除授权 必填项:授权id(permissionsId)，资源id(resourcesId)，和类型(type)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appId | appId | query | false | string | |
| createBy | 创建人 | query | false | string | |
| createTime | 创建时间 | query | false | string(date-time) | |
| description | 资源描述 | query | false | string | |
| id | id | query | false | string | |
| isPermit | 是否允许使用 | query | false | integer(int32) | |
| parentId | 父节点id | query | false | string | |
| parentName | 父节点名称 | query | false | string | |
| permissionsId | 被授权的id | query | false | string | |
| permissionsName | 授权对象名 | query | false | string | |
| resourceId | resourceId | query | false | string | |
| resourceName | resourceName | query | false | string | |
| resourceType | resourceType | query | false | string | |
| status | 状态 | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string | |
| type | 类型 | query | false | string | |
| updateBy | 修改人 | query | false | string | |
| updateTime | 修改时间 | query | false | string(date-time) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询用户在对应APP中的权限列表，服务于SDK的接口
接口地址:/api/apusic/v1.0/permissions/apps/{appId}/users/{userId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---查询用户在对应APP中的权限列表，服务于SDK的接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appId | appId | path | true | string | |
| userId | userId | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询(根据资源名模糊查询)根据权限分类资源
接口地址:/api/apusic/v1.0/permissions/authDomain
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查询(根据资源名模糊查询)根据权限分类资源
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| authId | authId | query | false | string | |
| resourceName | resourceName | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«权限资源分组VO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | 权限资源分组VO |
| authDomainName | string | ||
| id | string | ||
| resourcesList | array | Resources | |
| appId | string | ||
| appName | string | ||
| authDomain | string | ||
| authDomainName | 权限分组名称 | string | |
| childPasswordStatus | 是否需要子账号密码 | integer | |
| createBy | string | ||
| createTime | string | ||
| description | string | ||
| groupId | 分组id | string | |
| id | string | ||
| name | string | ||
| parentId | string | ||
| parentName | string | ||
| protocol | 单点登录类型 | string | |
| resourceAction | string | ||
| resourceIcon | string | ||
| resourceStyle | string | ||
| resourceType | string | ||
| resourceUrl | string | ||
| rolesId | string | ||
| sortIndex | integer | ||
| status | integer | ||
| subAccountStatus | 是否拥有子账户（1表示有子账户 0表示没有子账户） | integer | |
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string | ||
| userId | string | ||
| userInfoId | string | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authDomainName": "",
"id": "",
"resourcesList": [
{
"appId": "",
"appName": "",
"authDomain": "",
"authDomainName": "",
"childPasswordStatus": 0,
"createBy": "",
"createTime": "",
"description": "",
"groupId": "",
"id": "",
"name": "",
"parentId": "",
"parentName": "",
"protocol": "",
"resourceAction": "",
"resourceIcon": "",
"resourceStyle": "",
"resourceType": "",
"resourceUrl": "",
"rolesId": "",
"sortIndex": 0,
"status": 0,
"subAccountStatus": 0,
"tenantId": "",
"updateBy": "",
"updateTime": "",
"userId": "",
"userInfoId": ""
}
]
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# 删除权限域授权
接口地址:/api/apusic/v1.0/permissions/authDomain
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---删除授权 必填项:授权id(permissionsId)，权限域id(authId)，和类型(type)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| authId | 6353654 | query | false | string | |
| permissionsId | 254235843643 | query | false | string | |
| type | USER | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 权限域查看授权
接口地址:/api/apusic/v1.0/permissions/authDomain/{authId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查看权限域下授权 必填项:authId(权限域Id) pagination
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| authId | authId | path | true | string | |
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查看授权主体信息
接口地址:/api/apusic/v1.0/permissions/permissionsId
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---查看授权主体信息 必填项:授权id(permissionsId)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| permissionsId | permissionsId | query | false | string | |
| type | type | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询未授权访问给指定应用的分组列表
接口地址:/api/apusic/v1.0/permissions/unGroups
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---(必须输入:appId,选择输入:组织名,groupName)查询未授权访问给制定应用的分组列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | query | false | string | ||
| authId | query | false | string | ||
| groupName | query | false | string | ||
| orgName | query | false | string | ||
| type | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«Group对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | Group对象 |
| createTime | 创建日期 | string(date-time) | |
| description | 描述 | string | |
| groupMembers | 组内成员个数 | integer(int32) | |
| id | 分组ID | string | |
| name | 分组名字 | string | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"createTime": "",
"description": "",
"groupMembers": 0,
"id": "",
"name": "",
"tenantId": 5641566
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 查询未授权访问给指定应用的组织列表
接口地址:/api/apusic/v1.0/permissions/unOrgs
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---(必须输入:appId,选择输入:组织名,orgName)查询未授权访问给制定应用的组织列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | query | false | string | ||
| authId | query | false | string | ||
| groupName | query | false | string | ||
| orgName | query | false | string | ||
| type | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«OrgVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer(int32) | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer(int32) | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# 查询未授权该应用的角色接口
接口地址:/api/apusic/v1.0/permissions/unroles
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---(必须输入:appId,选择输入:角色名)查询未授权该应用的角色rolesName
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | appId | query | false | string | |
| createBy | 创建人 | query | false | string | |
| createTime | 创建时间 | query | false | string(date-time) | |
| extendRole | 是否继承于角色 | query | false | integer(int32) | |
| isPermit | 是否允许使用 | query | false | integer(int32) | |
| resourceId | resourceId | query | false | string | |
| rolesName | 角色名 | query | false | string | |
| status | 状态 | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string | |
| updateBy | 修改人 | query | false | string | |
| updateTime | 修改时间 | query | false | string(date-time) | |
| userInfoId | userInfoId | query | false | string | |
| userName | 用户名/姓名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuthDomain对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuthDomain对象 |
| appCategoryStatus | 应用类型状态(集成应用为0/标准协议为1) | integer(int32) | |
| appId | 应用id | string | |
| authDomainName | 权限域 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | 权限域主键 | string | |
| protocol | 所属协议类型 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| authDomain | 权限人 | string | |
| children | 子节点 | array | Resources对象 |
| createTime | 创建时间 | string | |
| description | 描述 | string | |
| disabled | 该资源是否可选，如果用户已经拥有该资源，则disabled为true，不能再进行选择添加 | boolean | |
| id | id | string | |
| level | integer | ||
| name | 资源名称 | string | |
| parentId | 父节点id | string | |
| parentName | 父节点名称 | string | |
| resourceIcon | 资源图标 | string | |
| resourceType | 资源类型 | string | |
| resourceUrl | 资源标识 | string | |
| resourcesList | 资源集合 | array | Resources对象 |
| sortIndex | 排序 | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| rolesList | 角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"appCategoryStatus": 1,
"appId": "c65950443ce74d52ab246c32ef86df5d",
"authDomainName": "AIDM APP",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"description": "这是一个描述。。。。",
"disabled": true,
"id": "0b87cc22155849f78c07a79010e42641",
"protocol": "",
"resourcesList": [
{
"authDomain": "",
"children": [
{
"authDomain": "",
"children": [
{}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"createTime": "",
"description": "",
"disabled": true,
"id": "",
"level": 0,
"name": "",
"parentId": 5641566,
"parentName": "/首页/",
"resourceIcon": "",
"resourceType": "",
"resourceUrl": "",
"resourcesList": [
{}
],
"sortIndex": 0,
"tenantId": 5641566
}
],
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# 查询未授权该应用的用户接口
接口地址:/api/apusic/v1.0/permissions/unuser
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---(必须输入:appId,选择输入:用户名或姓名userName)查询未授权该应用的用户
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| appId | appId | query | false | string | |
| createBy | 创建人 | query | false | string | |
| createTime | 创建时间 | query | false | string(date-time) | |
| extendRole | 是否继承于角色 | query | false | integer(int32) | |
| isPermit | 是否允许使用 | query | false | integer(int32) | |
| resourceId | resourceId | query | false | string | |
| rolesName | 角色名 | query | false | string | |
| status | 状态 | query | false | integer(int32) | |
| tenantId | 租户 | query | false | string | |
| updateBy | 修改人 | query | false | string | |
| updateTime | 修改时间 | query | false | string(date-time) | |
| userInfoId | userInfoId | query | false | string | |
| userName | 用户名/姓名 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«UserInfo对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | UserInfo对象 |
| authnType | 认证类型（用户名密码/手机） | integer(int32) | |
| badPasswordCount | 输入密码错误次数 | integer(int32) | |
| badPasswordTime | 输入密码错误时间 | string | |
| birthDate | 生日 | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string(date-time) | |
| displayName | 用户中文名称 | string | |
| 邮箱 | string | ||
| emailVerified | 邮箱验证 | integer(int32) | |
| employeeNumber | 员工编号 | string | |
| expireStatus | 是否过期 | string | |
| expireTime | 过期时间 | string | |
| extendDataList | 用户扩展字段集合 | array | UserinfoExtendAttr2Data对象 |
| checks | array | EnumVO | |
| id | string | ||
| name | string | ||
| value | string | ||
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| dataType | string | ||
| description | string | ||
| extendAttrData | string | ||
| extendAttrKey | string | ||
| extendAttrName | string | ||
| extendId | string | ||
| isEdit | integer | ||
| isNull | integer | ||
| isUnique | integer | ||
| isVisible | integer | ||
| sortIndex | integer | ||
| tenantId | 租户 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| familyName | 姓 | string | |
| gender | 性别（0未知;1女性;2男性） | integer(int32) | |
| homeEmail | 住址电邮 | string | |
| id | 用户主键 | string | |
| idCardNo | 身份证号 | string | |
| idType | 证件类型（0未知;1身份证;2护照;3学生证;4军人证） | integer(int32) | |
| isLocked | 用户是否锁定 | integer(int32) | |
| lastLoginIp | 用户末次登录ip | string | |
| lastLoginTime | 用户末次登录时间 | string | |
| lastLogoffTime | 用户末次登出时间 | string | |
| licenseConnections | 套餐人数 | integer(int32) | |
| locale | 地点 | string | |
| loginCount | 登录次数 | integer(int32) | |
| managerType | 管理员类型（1为是，2为否） | integer(int32) | |
| married | 婚姻类型（0未知 ;1单身;2结婚;3离异;4丧偶） | integer(int32) | |
| mobile | 手机号 | string | |
| online | 是否在线（1在线，0下线） | integer(int32) | |
| orgList | 用户所属组织集合 | array | OrgVO |
| children | 子结点列表 | array | OrgVO |
| description | 组织描述 | string | |
| disabled | 该组织是否可选，如果组织已经被选定，则disabled为true，不能再进行选择添加 | boolean | |
| extendId | 外部编号 | string | |
| id | 组织主键 | string | |
| isLeaf | boolean | ||
| level | 当前层级 | integer | |
| name | 组织名称 | string | |
| namePath | 名称路径 | string | |
| parentId | 父结点 | string | |
| sortIndex | 排序编号 | integer | |
| tenantId | 租户id | string | |
| type | 组织类型 | string | |
| passwordLastSetTime | 密码过期时间 | string | |
| passwordSetType | 密码设置类型 | integer(int32) | |
| picture | 照片 | string | |
| quitDate | 离职日期 | string | |
| rolesList | 用户所属角色集合 | array | Roles对象 |
| authDomain | 权限域（选择的权限域中的域id） | string | |
| authDomainName | 权限域（选择的权限域中的域名称） | string | |
| createBy | 创建人 | string | |
| createTime | 创建时间 | string | |
| createdBy | 创建人 | string | |
| createdDate | 创建时间 | string | |
| description | 描述 | string | |
| id | 角色主键 | string | |
| modifiedBy | 修改人 | string | |
| modifiedDate | 修改时间 | string | |
| name | 角色名称（唯一） | string | |
| orgExtendRole | 是否为组织继承角色(1为是,0为否) | integer | |
| status | 角色状态(1为启用，0为停用) | integer | |
| tenantId | 租户id（选择的权限域中的域名,默认为0） | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string | |
| userCount | 用户数量 | integer | |
| startWorkDate | 开始工作时间 | string | |
| status | 状态 | integer(int32) | |
| tenantId | 租户 | string | |
| unLockTime | 用户解锁时间 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| userCount | 用户总数 | integer(int32) | |
| userState | 用户地区 | string | |
| userType | 用户类型 | string | |
| username | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"authnType": 1,
"badPasswordCount": 2,
"badPasswordTime": "2021-11-02 09:56:34",
"birthDate": "1997-01-01",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"displayName": "张三",
"email": "89465156@qq.com",
"emailVerified": 1,
"employeeNumber": 10051,
"expireStatus": 0,
"expireTime": "2029-09-09 10:00:00",
"extendDataList": [
{
"checks": [
{
"id": "",
"name": "",
"value": ""
}
],
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"dataType": "",
"description": "",
"extendAttrData": "",
"extendAttrKey": "",
"extendAttrName": "",
"extendId": "",
"isEdit": 0,
"isNull": 0,
"isUnique": 0,
"isVisible": 0,
"sortIndex": 0,
"tenantId": 0,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00"
}
],
"familyName": "张",
"gender": 1,
"homeEmail": "15605469874@XX.com",
"id": 622227747934179401,
"idCardNo": 420116199901011234,
"idType": 1,
"isLocked": 1,
"lastLoginIp": "",
"lastLoginTime": "2021-11-02 09:56:34",
"lastLogoffTime": "2021-11-02 09:56:34",
"licenseConnections": 3000,
"locale": "湖北省武汉市江汉区电力社区",
"loginCount": 132,
"managerType": 1,
"married": 1,
"mobile": 15607164562,
"online": 0,
"orgList": [
{
"children": [
{
"children": [
{}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"description": "",
"disabled": true,
"extendId": "",
"id": "",
"isLeaf": true,
"level": 0,
"name": "",
"namePath": "",
"parentId": "",
"sortIndex": 0,
"tenantId": "",
"type": ""
}
],
"passwordLastSetTime": "2021-11-02 09:56:34",
"passwordSetType": 1,
"picture": "",
"quitDate": "2021-12-02",
"rolesList": [
{
"authDomain": "589e9948-d459-4261-b8ef-9a5e829024b0",
"authDomainName": "AppName",
"createBy": "admin",
"createTime": "2020-10-10 10:00:00",
"createdBy": "张三管理员",
"createdDate": "2021-11-02 09:56:34",
"description": "人力资源总监",
"id": "0b87cc22155849f78c07a79010e42641",
"modifiedBy": "张三管理员",
"modifiedDate": "2021-11-08 09:56:34",
"name": "人力资源总监",
"orgExtendRole": 0,
"status": 1,
"tenantId": 5641566,
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 9
}
],
"startWorkDate": "2021-11-02 09:56:34",
"status": 1,
"tenantId": 0,
"unLockTime": "2021-11-02 09:56:34",
"updateBy": "admin",
"updateTime": "2020-10-10 10:00:00",
"userCount": 44,
"userState": "RESIDENT",
"userType": "EMPLOYEE",
"username": "admin"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# 1-18-formbased协议接入模块
# 添加应用
接口地址:/api/apusic/v1.0/formbased
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---添加应用
请求示例:
{
"authorizeSuccessUrl": "http://localhost:9000",
"authorizeUrl": "http://localhost:9000",
"description": "gitlab",
"iconUrl": "/aidm/pic/5646.jpg",
"id": 15684564666854,
"loginAttr": "<input type=\"hidden\" name=\"spt\" value=\"123\">",
"loginBtnSelector": "POST",
"loginPwdSelector": "qq123456",
"loginUsernameSelector": "zhangsan",
"name": "gitlab",
"protocol": "OAuth_v2.0/OAuth_v2.1/OpenID_Connect_v1.0/Form_Based/CAS",
"tenantId": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | FormBased协议创建请求类 | body | true | FormBasedDetailsCreateRequest | FormBasedDetailsCreateRequest |
| authorizeSuccessUrl | 登录成功跳转地址 | false | string | ||
| authorizeUrl | 登录提交URI | false | string | ||
| description | 应用描述 | false | string | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| loginAttr | 登录其他信息 | false | string | ||
| loginBtnSelector | 提交按钮选择器 | false | string | ||
| loginPwdSelector | 登录密码选择器 | false | string | ||
| loginUsernameSelector | 登录名选择器 | false | string | ||
| name | 应用名称 | false | string | ||
| protocol | 协议名 | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 根据clientId查询应用信息
接口地址:/api/apusic/v1.0/formbased/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---根据clientId查询应用信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«FormBasedDetailsShowVO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | FormBasedDetailsShowVO | FormBasedDetailsShowVO |
| appId | 应用ID | string | |
| appName | 应用名称 | string | |
| authorizeSuccessUrl | 登录成功跳转地址 | string | |
| authorizeUrl | 登录提交URI | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 应用描述 | string | |
| iconUrl | icon url | string | |
| loginAttr | 登录其他信息 | string | |
| loginBtnSelector | 提交按钮选择器 | string | |
| loginPwdSelector | 登录密码选择器 | string | |
| loginUsernameSelector | 登录名选择器 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appId": 15684564666854,
"appName": "gitlab",
"authorizeSuccessUrl": "http://localhost:9000",
"authorizeUrl": "http://localhost:9000",
"createTime": "2022-01-01 12:00:00",
"description": "gitlab",
"iconUrl": "http://localhost:9000",
"loginAttr": "<input type=\"hidden\" name=\"spt\" value=\"123\">",
"loginBtnSelector": "POST",
"loginPwdSelector": "qq123456",
"loginUsernameSelector": "zhangsan"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 根据clientId更新应用信息
接口地址:/api/apusic/v1.0/formbased/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---根据id更新应用信息
请求示例:
{
"authorizeSuccessUrl": "http://localhost:9000",
"authorizeUrl": "http://localhost:9000",
"description": "gitlab",
"iconUrl": "http://localhost:9000",
"id": 15684564666854,
"loginAttr": "{\"email\":\"18947539527\"}",
"loginBtnSelector": "POST",
"loginPwdSelector": "qq123456",
"loginUsernameSelector": "zhangsan",
"name": "gitlab"
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | FormBased协议编辑请求类 | body | true | FormBasedDetailsEditRequest | FormBasedDetailsEditRequest |
| authorizeSuccessUrl | 登录成功跳转地址 | false | string | ||
| authorizeUrl | 登录提交URI | false | string | ||
| description | 应用描述 | false | string | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| loginAttr | 登录其他信息 | false | string | ||
| loginBtnSelector | 提交按钮选择器 | false | string | ||
| loginPwdSelector | 登录密码选择器 | false | string | ||
| loginUsernameSelector | 登录名选择器 | false | string | ||
| name | 应用名称 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-19-电子邮件接口文档模块
# 查询邮件模板接口
接口地址:/api/apusic/v1.0/email_template
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询邮件模板信息地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«EmailTemplate对象»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | EmailTemplate对象 |
| description | 描述 | string | |
| emailTemplateCode | 邮件模板代码 | integer(int32) | |
| emailTemplateName | 邮件模板名称 | string | |
| id | 主键 | string | |
| messageTemplate | 模板内容 | string | |
| status | 邮件模板名称 | integer(int32) | |
| subject | 主体 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"description": "描述.......",
"emailTemplateCode": "0b87cc22155849f78c07a79010e42641",
"emailTemplateName": "绑定邮箱",
"id": 1,
"messageTemplate": "",
"status": 1,
"subject": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 单个邮件模板查看接口
接口地址:/api/apusic/v1.0/email_template/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---邮件模板查看接口地址(传入id邮箱模板主键)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«EmailTemplate对象» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | EmailTemplate对象 | EmailTemplate对象 |
| description | 描述 | string | |
| emailTemplateCode | 邮件模板代码 | integer(int32) | |
| emailTemplateName | 邮件模板名称 | string | |
| id | 主键 | string | |
| messageTemplate | 模板内容 | string | |
| status | 邮件模板名称 | integer(int32) | |
| subject | 主体 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"description": "描述.......",
"emailTemplateCode": "0b87cc22155849f78c07a79010e42641",
"emailTemplateName": "绑定邮箱",
"id": 1,
"messageTemplate": "",
"status": 1,
"subject": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 编辑邮件模板接口
接口地址:/api/apusic/v1.0/email_template/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---编辑邮件模板地址(id为角色主键，实体类为修改内容)
请求示例:
{
"messageTemplate": "",
"subject": ""
}
1
2
3
4
2
3
4
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 邮箱模板修改实体类 | body | true | EmailTemplateEditRequest | EmailTemplateEditRequest |
| messageTemplate | 邮件模板正文内容 | false | string | ||
| subject | 邮件模板主体(标题) | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«EmailTemplate对象» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | EmailTemplate对象 | EmailTemplate对象 |
| description | 描述 | string | |
| emailTemplateCode | 邮件模板代码 | integer(int32) | |
| emailTemplateName | 邮件模板名称 | string | |
| id | 主键 | string | |
| messageTemplate | 模板内容 | string | |
| status | 邮件模板名称 | integer(int32) | |
| subject | 主体 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"description": "描述.......",
"emailTemplateCode": "0b87cc22155849f78c07a79010e42641",
"emailTemplateName": "绑定邮箱",
"id": 1,
"messageTemplate": "",
"status": 1,
"subject": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 1-20-系统参数配置模块
# 查询系统配置参数
接口地址:/api/apusic/v1.0/sysconfig
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---查询系统配置参数
请求示例:
{
"platform": 0,
"sysModuleCode": "log",
"sysName": "aidm.log"
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| sysConfigQuery | 系统参数查询类 | body | true | SysConfigQuery | SysConfigQuery |
| platform | 平台标识：0-系统参数 1-业务参数 | false | integer(int32) | ||
| sysModuleCode | 系统所属模块code | false | string | ||
| sysName | 系统属性名称 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«SysConfig»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | SysConfig |
| createBy | string | ||
| createTime | string(date-time) | ||
| description | string | ||
| id | string | ||
| platform | integer(int32) | ||
| status | integer(int32) | ||
| sysModuleCode | string | ||
| sysModuleName | string | ||
| sysName | string | ||
| sysValue | string | ||
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string(date-time) | ||
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"createBy": "",
"createTime": "",
"description": "",
"id": "",
"platform": 0,
"status": 0,
"sysModuleCode": "",
"sysModuleName": "",
"sysName": "",
"sysValue": "",
"tenantId": "",
"updateBy": "",
"updateTime": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# 添加系统配置参数
接口地址:/api/apusic/v1.0/sysconfig
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---添加系统配置参数
请求示例:
{
"description": "日志级别",
"platform": 0,
"sysModuleCode": "log",
"sysModuleName": "log",
"sysName": "aidm.log",
"sysValue": "debug"
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 系统参数配置创建请求类 | body | true | SysConfigRequest | SysConfigRequest |
| description | 参数描述 | false | string | ||
| platform | 平台标识：0-系统参数 1-业务参数 | false | integer(int32) | ||
| sysModuleCode | 系统所属模块code | false | string | ||
| sysModuleName | 系统所属模块名称 | false | string | ||
| sysName | 系统属性名称 | false | string | ||
| sysValue | 系统属性值 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«boolean» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | boolean | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": true,
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 编辑登录图片-文字-版权
接口地址:/api/apusic/v1.0/sysconfig/individuation/config
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
潘文竹---编辑登录图片/文字/版权
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| map | map | body | true |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询个性化
接口地址:/api/apusic/v1.0/sysconfig/individuation/map
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
潘文竹---查询个性化
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Map«string,string»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 编辑系统配置参数
接口地址:/api/apusic/v1.0/sysconfig/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---编辑系统配置参数
请求示例:
{
"description": "日志级别",
"platform": 0,
"sysModuleCode": "log",
"sysModuleName": "log",
"sysName": "aidm.log",
"sysValue": "debug"
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | 系统参数配置创建请求类 | body | true | SysConfigRequest | SysConfigRequest |
| description | 参数描述 | false | string | ||
| platform | 平台标识：0-系统参数 1-业务参数 | false | integer(int32) | ||
| sysModuleCode | 系统所属模块code | false | string | ||
| sysModuleName | 系统所属模块名称 | false | string | ||
| sysName | 系统属性名称 | false | string | ||
| sysValue | 系统属性值 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«boolean» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | boolean | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": true,
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除系统配置参数
接口地址:/api/apusic/v1.0/sysconfig/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---删除系统配置参数
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | 单个或者多个，多个以逗号分隔 | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«boolean» |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | boolean | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": true,
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-21-cas协议接入模块
# 添加应用
接口地址:/api/apusic/v1.0/cas
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---添加应用
请求示例:
{
"callbackUrl": "http://localhost:9000",
"description": "gitlab",
"expires": 60,
"iconUrl": "/aidm/pic/5646.jpg",
"id": 15684564666854,
"name": "gitlab",
"protocol": "OAuth_v2.0/OAuth_v2.1/OpenID_Connect_v1.0/Form_Based/CAS",
"service": "http://localhost:9000",
"tenantId": 0
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | CAS协议创建请求类 | body | true | AppsCasDetailsCreateRequest | AppsCasDetailsCreateRequest |
| callbackUrl | 回调地址 | false | string | ||
| description | 应用描述 | false | string | ||
| expires | 过期时间：单位秒（s） | false | integer(int32) | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| name | 应用名称 | false | string | ||
| protocol | 协议名 | false | string | ||
| service | cas Service | false | string | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 根据clientId查询应用信息
接口地址:/api/apusic/v1.0/cas/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---根据clientId查询应用信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«AppsCasDetailsShowVO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | AppsCasDetailsShowVO | AppsCasDetailsShowVO |
| appId | 应用ID | string | |
| appName | 应用名称 | string | |
| callbackUrl | 回调地址 | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 应用描述 | string | |
| expires | 过期时间：单位秒（s） | integer(int32) | |
| iconUrl | icon url | string | |
| service | cas Service | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appId": 15684564666854,
"appName": "gitlab",
"callbackUrl": "http://localhost:9000",
"createTime": "2022-01-01 12:00:00",
"description": "gitlab",
"expires": 60,
"iconUrl": "http://localhost:9000",
"service": "http://localhost:9000"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 根据clientId更新应用信息
接口地址:/api/apusic/v1.0/cas/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---根据id更新应用信息
请求示例:
{
"callbackUrl": "http://localhost:9000",
"description": "gitlab",
"expires": 60,
"iconUrl": "http://localhost:9000",
"id": 15684564666854,
"name": "gitlab",
"service": "http://localhost:9000"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| request | CAS协议编辑请求类 | body | true | AppsCasDetailsEditRequest | AppsCasDetailsEditRequest |
| callbackUrl | 回调地址 | false | string | ||
| description | 应用描述 | false | string | ||
| expires | 过期时间：单位秒（s） | false | integer(int32) | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| name | 应用名称 | false | string | ||
| service | cas Service | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-22-quartz job模块
# 查询所有定时job
接口地址:/api/apusic/quartz
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
张玉波---查询所有定时job
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除一个定时job
接口地址:/api/apusic/quartz
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
张玉波---删除一个定时job
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| jobGroupName | jobGroupName | body | true | string | |
| jobName | jobName | body | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 添加一个定时job
接口地址:/api/apusic/quartz/add
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---添加一个定时job
请求示例:
{
"cronTimes": "0/10 * * * * ?",
"jobClassStr": "com.apusic.idm.v1.persistence.job.UserInfoJob",
"jobData": {
"param": "value"
},
"jobGroupName": "userInfoJobGroup",
"jobName": "userInfoExpiredJob",
"jobTime": 10,
"jobTimes": -1
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| addRequst | quartz定时任务添加类 | body | true | QuartzJobAddVO | QuartzJobAddVO |
| cronTimes | cron 表达式 | false | string | ||
| jobClassStr | 任务实现类 | false | string | ||
| jobData | 任务传递参数 | false | object | ||
| jobGroupName | 任务组名 | false | string | ||
| jobName | 任务名称 | false | string | ||
| jobTime | 时间表达式 (每隔多少秒为一次任务) | false | integer(int32) | ||
| jobTimes | 运行的次数 （<0:表示不限次数） | false | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 停止-恢复一个定时job
接口地址:/api/apusic/quartz/change
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
张玉波---停止/恢复所有定时job
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| jobGroupName | 任务分组 | body | true | string | |
| jobName | 任务名 | body | true | string | |
| status | 0-停止/其他-恢复 | body | false | integer |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 启动所有定时job
接口地址:/api/apusic/quartz/resumeAll
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
张玉波---启动所有定时job
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 立刻执行一个定时job
接口地址:/api/apusic/quartz/startJob
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
张玉波---立刻执行一个定时job
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| jobGroupName | jobGroupName | query | true | string | |
| jobName | jobName | query | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 停止所有定时job
接口地址:/api/apusic/quartz/stopAll
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
张玉波---停止所有定时job
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 修改一个定时job
接口地址:/api/apusic/quartz/update
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---修改一个定时job
请求示例:
{
"cronTimes": "0/10 * * * * ?",
"jobClassStr": "com.apusic.idm.v1.persistence.job.UserInfoJob",
"jobData": {
"param": "value"
},
"jobGroupName": "userInfoJobGroup",
"jobName": "userInfoExpiredJob",
"jobTime": 10,
"jobTimes": -1
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| editRequest | quartz定时任务添加类 | body | true | QuartzJobAddVO | QuartzJobAddVO |
| cronTimes | cron 表达式 | false | string | ||
| jobClassStr | 任务实现类 | false | string | ||
| jobData | 任务传递参数 | false | object | ||
| jobGroupName | 任务组名 | false | string | ||
| jobName | 任务名称 | false | string | ||
| jobTime | 时间表达式 (每隔多少秒为一次任务) | false | integer(int32) | ||
| jobTimes | 运行的次数 （<0:表示不限次数） | false | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 1-23-集成应用模板接口文档模块
# 查询集成应用模板接口
接口地址:/api/apusic/v1.0/apps/model
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
肖清---添加集成应用模板接口
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AppsModelShowVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AppsModelShowVO |
| clickable | 是否可点击 | integer(int32) | |
| iconUrl | 图标url | string | |
| id | 集成应用模板id | string | |
| name | 集成应用模板名称 | string | |
| protocol | 集成应用协议名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"clickable": 1,
"iconUrl": "http://localhost:9000/minio",
"id": 12356489154,
"name": "jira",
"protocol": "FormBased"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 添加集成应用模板接口
接口地址:/api/apusic/v1.0/apps/model
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---添加集成应用模板接口
请求示例:
{
"attr1": "{\"loginUsernameSelector\":\"#j_username\",\"loginPwdSelector\":\"input[name='j_password']\",\"loginBtnSelector\":\"input[name='Submit']\",\"authorizeView\":\"https://jenkins.apusic.net/login\"}",
"attr2": "{}",
"category": "HR",
"clickable": 1,
"description": "gitlab",
"iconUrl": "/aidm/pic/5646.jpg",
"id": 15684564666854,
"name": "gitlab",
"protocol": "OAuth_v2.0/OAuth_v2.1/OpenID_Connect_v1.0/Form_Based/CAS",
"status": 1,
"tenantId": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | Apps集成应用创建请求类 | body | true | AppsModelCreateRequest | AppsModelCreateRequest |
| attr1 | 备用字段1 | false | string | ||
| attr2 | 备用字段2 | false | string | ||
| category | 应用类型(系统分类) | false | string | ||
| clickable | 是否可点击的:0-不可点击/1-可点击 | false | integer(int32) | ||
| description | 应用描述 | false | string | ||
| iconUrl | icon url | false | string | ||
| id | 应用ID | false | string | ||
| name | 应用名称 | false | string | ||
| protocol | 协议名 | false | string | ||
| status | 状态:0-无效/1-有效 | false | integer(int32) | ||
| tenantId | 租户id | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 集成应用模板生成应用接口
接口地址:/api/apusic/v1.0/apps/model/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
肖清---集成应用模板生成应用接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 2-01认证总地址文档模块
# 认证总地址接口
接口地址:/api/apusic/authz/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
参数应用ID，分发到不同应用的认证地址
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 跳转前校验接口
接口地址:/api/apusic/authz/{id}/validate
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
跳转前校验接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 2-02-OAuth v2.0 API文档模块
# OAuth 2.0 认证接口
接口地址:/api/apusic/authz/oauth/v20/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
传递参数应用ID，自动完成跳转认证拼接，供程序内部调用
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 2-03-SAML v2.0 API文档模块
# SAML 2.0 Assertion接口
接口地址:/api/apusic/authz/saml20/assertion
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
进行断言并发送
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# SAML 2.0 IDP Init接口
接口地址:/api/apusic/authz/saml20/idpinit/{appid}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
传递参数应用ID
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appid | appid | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 2-04-FormBased接口文档模块
# FormBased认证地址接口
接口地址:/api/apusic/authz/formbased/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
参数应用ID
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 2-07-ldap接口文档模块
# 加密
接口地址:/api/apusic/v1.0/ldap/encodePassword
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---加密
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pwd | pwd | query | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
1
# 同步
接口地址:/api/apusic/v1.0/ldap/sync
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴刘瑱---同步
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
1
# 2-4-CAS REST API文档模块
# CAS REST认证接口
接口地址:/api/apusic/authz/cas/v1/tickets
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
通过用户名密码获取TGT
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| password | formData | false | string | ||
| service | formData | false | string | ||
| username | formData | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
1
# CAS REST认证接口
接口地址:/api/apusic/authz/cas/v1/tickets/{ticketGrantingTicket}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
检查TGT状态
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| ticketGrantingTicket | ticketGrantingTicket | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
1
# CAS REST认证接口
接口地址:/api/apusic/authz/cas/v1/tickets/{ticketGrantingTicket}
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
通过TGT获取ST
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| ticketGrantingTicket | ticketGrantingTicket | path | true | string | |
| password | formData | false | string | ||
| service | formData | false | string | ||
| renew | formData | false | string | ||
| username | formData | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
1
# CAS REST认证接口
接口地址:/api/apusic/authz/cas/v1/tickets/{ticketGrantingTicket}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
注销TGT状态
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| ticketGrantingTicket | ticketGrantingTicket | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# CAS REST认证接口
接口地址:/api/apusic/authz/cas/v1/users
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
用户名密码登录接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| password | formData | false | string | ||
| service | formData | false | string | ||
| username | formData | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
1
# 3-01-在线ticket文档模块
# 在线ticket验证接口
接口地址:/api/apusic/onlineticket/validate
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
在线ticket验证接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| ticket | ticket | query | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# 3-02-社交软件登录
# 社交软件认证
接口地址:/api/apusic/logon/oauth20/authorize/{provider}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
社交软件认证
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| provider | 社交软件提供商code | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 社交软件绑定
接口地址:/api/apusic/logon/oauth20/bind/{provider}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
社交软件绑定
请求示例:
{
"password": 593887578604699648,
"username": 593887578604699648,
"uuid": "tVsNMTEwMzIwMjIxNjE2MjMyMTceiJ"
}
1
2
3
4
5
2
3
4
5
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| bindRequestVO | 社交参数绑定请求类 | body | true | BindRequestVO | BindRequestVO |
| password | aidm密码 | false | string | ||
| username | aidm用户名 | false | string | ||
| uuid | 唯一编号 | false | string | ||
| provider | 社交软件提供商code | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 社交软件扫描登录结果查询
接口地址:/api/apusic/logon/oauth20/{provider}/{uuid}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
社交软件扫描登录结果查询
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| provider | 社交软件提供商code | path | true | string | |
| uuid | 扫码登录唯一标识 | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 社交软件登录
接口地址:/api/apusic/logon/oauth20/{provider}/{uuid}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
社交软件登录
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| provider | 社交软件提供商code | path | true | string | |
| uuid | 扫码登录唯一标识 | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 3-03-01-CAS API文档模块
# CAS 1.0 ticket验证接口
接口地址:/api/apusic/authz/cas/validate
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
通过ticket获取当前登录用户信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| service | service参数 | query | true | string | |
| ticket | ticket参数 | query | true | string | |
| renew | renew参数 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# 3-03-02-CAS API文档模块
# CAS 2.0 ticket代理验证接口
接口地址:/api/apusic/authz/cas/proxyValidate
请求方式:POST
请求数据类型:application/json
响应数据类型:application/xml
接口描述:
通过ticket获取当前登录用户信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| service | service | query | true | string | |
| ticket | ticket | query | true | string | |
| format | format | query | false | string | |
| pgtUrl | pgtUrl | query | false | string | |
| renew | renew | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# CAS 2.0 ticket验证接口
接口地址:/api/apusic/authz/cas/serviceValidate
请求方式:POST
请求数据类型:application/json
响应数据类型:application/xml
接口描述:
通过ticket获取当前登录用户信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| service | service | query | true | string | |
| ticket | ticket | query | true | string | |
| format | format | query | false | string | |
| pgtUrl | pgtUrl | query | false | string | |
| renew | renew | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# 3-03-03-CAS API文档模块
# CAS 3.0 ProxyTicket代理验证接口
接口地址:/api/apusic/authz/cas/p3/proxy
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
通过ProxyGrantingTicket获取ProxyTicket
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pgt | pgt | query | true | string | |
| targetService | targetService | query | true | string | |
| format | format | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# CAS 3.0 ticket代理验证接口
接口地址:/api/apusic/authz/cas/p3/proxyValidate
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
通过ProxyTicket获取当前登录用户信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| service | service | query | true | string | |
| ticket | ticket | query | true | string | |
| format | format | query | false | string | |
| pgtUrl | pgtUrl | query | false | string | |
| renew | renew | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# CAS 3.0 ticket验证接口
接口地址:/api/apusic/authz/cas/p3/serviceValidate
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
通过ticket获取当前登录用户信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| service | service | query | true | string | |
| ticket | ticket | query | true | string | |
| format | format | query | false | string | |
| pgtUrl | pgtUrl | query | false | string | |
| renew | renew | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
暂无
响应示例:
1
# 3-04-CAS API文档模块
# CAS页面跳转service认证接口
接口地址:/api/apusic/authz/cas/login
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
传递参数service
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| service | service | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# CAS注销接口
接口地址:/api/apusic/authz/cas/logout
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
CAS注销接口
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| service | service | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# CAS页面跳转应用ID认证接口
接口地址:/api/apusic/authz/cas/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
传递参数应用ID
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ModelAndView |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| empty | boolean | ||
| model | object | ||
| modelMap | object | ||
| reference | boolean | ||
| status | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string | |
| view | View | View | |
| contentType | string | ||
| viewName | string |
响应示例:
{
"empty": true,
"model": {},
"modelMap": {},
"reference": true,
"status": "",
"view": {
"contentType": ""
},
"viewName": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# saml20 应用管理
# 配置SAML应用
接口地址:/api/apusic/v1.0/apps/saml20
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
陈晨---配置SAML应用
请求示例:
{
"attrMap": {},
"audience": "https://localhost:8080",
"binding": "Redirect-Post",
"certId": 11111,
"description": "",
"digestMethod": "SHA1",
"encrypted": 0,
"entityId": "https://localhost:8080",
"iconUrl": "http://aidm.apusic.com/minio/aidm/saml1",
"id": 11111,
"identityId": "",
"idmLoginUrl": "",
"name": "JIRA",
"nameIdConvert": 0,
"nameIdFormat": "persistent",
"signAssertion": 0,
"signature": "RSAwithSHA1",
"spAcsUrl": "https://localhost:8080/plugins/servlet/samlconsumer",
"spLoginOutUrl": "",
"tenantId": 0,
"validityInterval": 15
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 应用添加请求 | body | true | saml20AppAddRequest | saml20AppAddRequest |
| attrMap | Assertion Attribute属性值 | false | object | ||
| audience | 受众 | false | string | ||
| binding | 消息传送方式 | true | string | ||
| certId | 证书id | false | string | ||
| description | 应用描述 | false | string | ||
| digestMethod | 摘要方式 | true | string | ||
| encrypted | 是否加密：0 false 1 true | true | integer(int32) | ||
| entityId | sp实体ID,第三方提供 | true | string | ||
| iconUrl | 应用图标url | false | string | ||
| id | 应用id | true | string | ||
| identityId | identityId | true | string | ||
| idmLoginUrl | IDM发起登录地址URL | false | string | ||
| name | saml应用名称 | false | string | ||
| nameIdConvert | nameId转换 | false | integer(int32) | ||
| nameIdFormat | 名称格式 | true | string | ||
| signAssertion | signAssertion,关：0，开：1 | true | string | ||
| signature | 签名算法 | true | string | ||
| spAcsUrl | sp断言接受URL | true | string | ||
| spLoginOutUrl | sp登录地址URL | false | string | ||
| tenantId | 租户id | false | string | ||
| validityInterval | 有效间隔期 | true | integer(int64) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«boolean» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | boolean | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": true,
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 根据id查询应用信息
接口地址:/api/apusic/v1.0/apps/saml20/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
根据id查询应用信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Saml20AppDetailDTO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | Saml20AppDetailDTO | Saml20AppDetailDTO |
| appId | 应用ID | string | |
| appName | 应用名称 | string | |
| assertionAttribute | string | ||
| attrMap | Assertion Attribute属性值 | object | |
| audience | 受众 | string | |
| binding | 消息传送方式 | string | |
| certId | 证书id | string | |
| createTime | 创建时间 | string(date-time) | |
| description | 应用描述 | string | |
| digestMethod | 摘要方式 | string | |
| encrypted | 是否加密：0 false 1 true | integer(int32) | |
| entityId | sp实体ID,第三方提供 | string | |
| iconUrl | 应用图标url | string | |
| identityId | identityId | string | |
| idmLoginUrl | IDM发起登录地址URL | string | |
| list | array | KeyValue | |
| key | string | ||
| value | object | ||
| nameIdConvert | nameId转换 | integer(int32) | |
| nameIdFormat | 名称格式 | string | |
| signAssertion | signAssertion,关：0，开：1 | string | |
| signature | 签名算法 | string | |
| spAcsUrl | sp断言接受URL | string | |
| spLoginOutUrl | sp登录地址URL | string | |
| tenantId | 租户id | string | |
| validityInterval | 有效间隔期 | integer(int64) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"appId": 15684564666854,
"appName": "gitlab",
"assertionAttribute": "",
"attrMap": {},
"audience": "https://localhost:8080",
"binding": "Redirect-Post",
"certId": 11111,
"createTime": "2022-01-01 12:00:00",
"description": "",
"digestMethod": "SHA1",
"encrypted": 0,
"entityId": "https://localhost:8080",
"iconUrl": "http://aidm.apusic.com/minio/aidm/saml1",
"identityId": "",
"idmLoginUrl": "",
"list": [
{
"key": "",
"value": {}
}
],
"nameIdConvert": 0,
"nameIdFormat": "persistent",
"signAssertion": 0,
"signature": "RSAwithSHA1",
"spAcsUrl": "https://localhost:8080/plugins/servlet/samlconsumer",
"spLoginOutUrl": "",
"tenantId": 0,
"validityInterval": 15
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 更新SAML应用
接口地址:/api/apusic/v1.0/apps/saml20/{id}
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
请求示例:
{
"attrMap": {},
"audience": "https://localhost:8080",
"binding": "Redirect-Post",
"certId": 11111,
"description": "",
"digestMethod": "SHA1",
"encrypted": 0,
"entityId": "https://localhost:8080",
"iconUrl": "http://aidm.apusic.com/minio/aidm/saml1",
"id": 11111,
"identityId": "",
"idmLoginUrl": "",
"name": "JIRA",
"nameIdConvert": 0,
"nameIdFormat": "persistent",
"signAssertion": 0,
"signature": "RSAwithSHA1",
"spAcsUrl": "https://localhost:8080/plugins/servlet/samlconsumer",
"spLoginOutUrl": "",
"tenantId": 0,
"validityInterval": 15
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 应用添加请求 | body | true | saml20AppAddRequest | saml20AppAddRequest |
| attrMap | Assertion Attribute属性值 | false | object | ||
| audience | 受众 | false | string | ||
| binding | 消息传送方式 | true | string | ||
| certId | 证书id | false | string | ||
| description | 应用描述 | false | string | ||
| digestMethod | 摘要方式 | true | string | ||
| encrypted | 是否加密：0 false 1 true | true | integer(int32) | ||
| entityId | sp实体ID,第三方提供 | true | string | ||
| iconUrl | 应用图标url | false | string | ||
| id | 应用id | true | string | ||
| identityId | identityId | true | string | ||
| idmLoginUrl | IDM发起登录地址URL | false | string | ||
| name | saml应用名称 | false | string | ||
| nameIdConvert | nameId转换 | false | integer(int32) | ||
| nameIdFormat | 名称格式 | true | string | ||
| signAssertion | signAssertion,关：0，开：1 | true | string | ||
| signature | 签名算法 | true | string | ||
| spAcsUrl | sp断言接受URL | true | string | ||
| spLoginOutUrl | sp登录地址URL | false | string | ||
| tenantId | 租户id | false | string | ||
| validityInterval | 有效间隔期 | true | integer(int64) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 删除SAML应用
接口地址:/api/apusic/v1.0/apps/saml20/{id}
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«boolean» |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | boolean | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": true,
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# signingKey管理(Certificate)
# 查询列表接口
接口地址:/api/apusic/v1.0/certificate
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
陈晨---查询列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| city | 城市 | query | false | string | |
| cityCode | 城市Code | query | false | string | |
| companyName | 公司名称 | query | false | string | |
| country | 国家 | query | false | string | |
| countryCode | 国家Code | query | false | string | |
| deptName | 部门名称 | query | false | string | |
| id | 应用主键 | query | false | string | |
| name | 名称 | query | false | string | |
| order | query | false | string | ||
| orderBy | query | false | string | ||
| province | 省份 | query | false | string | |
| provinceCode | 省份Code | query | false | string | |
| status | 证书状态，是否过期，0：未过期，1：已过期 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«CertificatePO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | CertificatePO |
| alias | 别名 | string | |
| certificateLength | 证书长度 | integer(int32) | |
| city | 城市 | string | |
| cityCode | 城市Code | string | |
| companyName | 公司名称 | string | |
| country | 国家 | string | |
| countryCode | 国家Code | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| deptName | 部门名称 | string | |
| id | 主键id | string | |
| name | 名称 | string | |
| province | 省份 | string | |
| provinceCode | 省份Code | string | |
| serialNumber | 序列号 | integer(int64) | |
| signatureAlgorithm | 签名算法 | string | |
| tenantId | 租户id | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| valid | 有效期，0:30天，1:180天，2:365天，3:3年 | string | |
| validTime | 30天，180天，365天，3年等时间段 | string | |
| validityTime | 有效期 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"alias": "CN=name,ST=province,C=country",
"certificateLength": 2048,
"city": "wuhan",
"cityCode": "",
"companyName": "深圳市金蝶天燕云计算股份有限公司",
"country": "CN",
"countryCode": "",
"createTime": "",
"createdBy": "",
"deptName": "金蝶天燕武汉研发部",
"id": "",
"name": "chen chen",
"province": "Hubei",
"provinceCode": "",
"serialNumber": 0,
"signatureAlgorithm": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"valid": "",
"validTime": "",
"validityTime": "2030-12-31"
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# 添加signingKey
接口地址:/api/apusic/v1.0/certificate
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
陈晨---添加证书
请求示例:
{
"status": ""
}
1
2
3
2
3
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 添加LicenseLog记录 | body | true | CertificateCreateRequest | CertificateCreateRequest |
| status | 0：证书到期30天之前，1：到期前30-15天，2：到期前15-1天，3：过期7天内,4:过期超过7天 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«CertificatePO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | CertificatePO | CertificatePO |
| alias | 别名 | string | |
| certificateLength | 证书长度 | integer(int32) | |
| city | 城市 | string | |
| cityCode | 城市Code | string | |
| companyName | 公司名称 | string | |
| country | 国家 | string | |
| countryCode | 国家Code | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| deptName | 部门名称 | string | |
| id | 主键id | string | |
| name | 名称 | string | |
| province | 省份 | string | |
| provinceCode | 省份Code | string | |
| serialNumber | 序列号 | integer(int64) | |
| signatureAlgorithm | 签名算法 | string | |
| tenantId | 租户id | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| valid | 有效期，0:30天，1:180天，2:365天，3:3年 | string | |
| validTime | 30天，180天，365天，3年等时间段 | string | |
| validityTime | 有效期 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"alias": "CN=name,ST=province,C=country",
"certificateLength": 2048,
"city": "wuhan",
"cityCode": "",
"companyName": "深圳市金蝶天燕云计算股份有限公司",
"country": "CN",
"countryCode": "",
"createTime": "",
"createdBy": "",
"deptName": "金蝶天燕武汉研发部",
"id": "",
"name": "chen chen",
"province": "Hubei",
"provinceCode": "",
"serialNumber": 0,
"signatureAlgorithm": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"valid": "",
"validTime": "",
"validityTime": "2030-12-31"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# 导出SigningKey
接口地址:/api/apusic/v1.0/certificate/export/{id}/{type}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
陈晨---id:saml的主键，type:1(DER文件类型),2(CER文件类型)
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string | |
| type | type | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
暂无
响应示例:
1
# 根据id查询Base64格式的证书
接口地址:/api/apusic/v1.0/certificate/getCert/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
陈晨---根据id查询Base64格式的证书
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | id | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«string» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": "",
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 导入SigningKey(P12文件格式)
接口地址:/api/apusic/v1.0/certificate/import
请求方式:POST
请求数据类型:multipart/form-data
响应数据类型:application/json
接口描述:
陈晨---swagger无法测试导入文件接口，请用postman或直接前端传入
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| file | file | body | true | string | |
| pwd | pwd | query | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«CertificatePO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | CertificatePO | CertificatePO |
| alias | 别名 | string | |
| certificateLength | 证书长度 | integer(int32) | |
| city | 城市 | string | |
| cityCode | 城市Code | string | |
| companyName | 公司名称 | string | |
| country | 国家 | string | |
| countryCode | 国家Code | string | |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| deptName | 部门名称 | string | |
| id | 主键id | string | |
| name | 名称 | string | |
| province | 省份 | string | |
| provinceCode | 省份Code | string | |
| serialNumber | 序列号 | integer(int64) | |
| signatureAlgorithm | 签名算法 | string | |
| tenantId | 租户id | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| valid | 有效期，0:30天，1:180天，2:365天，3:3年 | string | |
| validTime | 30天，180天，365天，3年等时间段 | string | |
| validityTime | 有效期 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"alias": "CN=name,ST=province,C=country",
"certificateLength": 2048,
"city": "wuhan",
"cityCode": "",
"companyName": "深圳市金蝶天燕云计算股份有限公司",
"country": "CN",
"countryCode": "",
"createTime": "",
"createdBy": "",
"deptName": "金蝶天燕武汉研发部",
"id": "",
"name": "chen chen",
"province": "Hubei",
"provinceCode": "",
"serialNumber": 0,
"signatureAlgorithm": "",
"tenantId": "",
"updateBy": "",
"updateTime": "",
"valid": "",
"validTime": "",
"validityTime": "2030-12-31"
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# 日志管理
# 查询列表接口
接口地址:/api/apusic/v1.0/loggerAudit
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
查询列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| endTime | 日志结束时间 | query | false | string | |
| endTimeDate | query | false | string(date-time) | ||
| isAdmin | 是否管理员，0为普通用户,1为管理员 | query | false | string | |
| isUser | 1表示管理员日志 0表示用户操作日志 | query | false | integer(int32) | |
| module | 模块名称 | query | false | string | |
| operationType | 操作类型 | query | false | string | |
| optResult | 接口返回代码(0或者错误码) | query | false | string | |
| startTime | 日志开始时间 | query | false | string | |
| startTimeDate | query | false | string(date-time) | ||
| userName | 操作人 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«List«AuspAuditLogVO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | array | AuspAuditLogVO |
| admin | boolean | ||
| appName | 应用名 | string | |
| className | 类名 | string | |
| content | 日志内容 | string | |
| createTime | 操作时间 | string(date-time) | |
| errMessage | 失败原因 | string | |
| id | 主键id | string | |
| ipAddr | ip地址 | string | |
| logType | 日志类型 | string | |
| methodName | 方法名 | string | |
| module | 模块名称 | string | |
| operation | 操作信息 | string | |
| operationType | 操作类型 | string | |
| optResult | 操作结果，0：请求成功，1：请求失败 | integer(int32) | |
| userId | 用户id | string | |
| userName | 用户名 | string | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": [
{
"admin": true,
"appName": "",
"className": "",
"content": "",
"createTime": "",
"errMessage": "",
"id": "",
"ipAddr": "",
"logType": "",
"methodName": "",
"module": "",
"operation": "",
"operationType": "",
"optResult": 0,
"userId": "",
"userName": ""
}
],
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# 添加日志
接口地址:/api/apusic/v1.0/loggerAudit
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
请求示例:
{
"appName": "",
"className": "",
"errMessage": "",
"ipAddr": "",
"logType": "",
"methodName": "",
"module": "",
"operation": "",
"operationType": "",
"optResult": 0,
"userId": "",
"userName": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 日志记录添加请求 | body | true | AuspAuditLogCreateRequest | AuspAuditLogCreateRequest |
| appName | false | string | |||
| className | false | string | |||
| errMessage | false | string | |||
| ipAddr | false | string | |||
| logType | false | string | |||
| methodName | false | string | |||
| module | false | string | |||
| operation | false | string | |||
| operationType | false | string | |||
| optResult | false | integer(int32) | |||
| userId | false | string | |||
| userName | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«boolean» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | boolean | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": true,
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 查询总数
接口地址:/api/apusic/v1.0/loggerAudit/count
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
查询总数
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| pageNum | query | true | integer(int32) | ||
| pageSize | query | true | integer(int32) | ||
| endTime | 日志结束时间 | query | false | string | |
| endTimeDate | query | false | string(date-time) | ||
| isAdmin | 是否管理员，0为普通用户,1为管理员 | query | false | string | |
| isUser | 1表示管理员日志 0表示用户操作日志 | query | false | integer(int32) | |
| module | 模块名称 | query | false | string | |
| operationType | 操作类型 | query | false | string | |
| optResult | 接口返回代码(0或者错误码) | query | false | string | |
| startTime | 日志开始时间 | query | false | string | |
| startTimeDate | query | false | string(date-time) | ||
| userName | 操作人 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«分页信息» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | 分页信息 | 分页信息 |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 短信接口模块
# 短信信息
接口地址:/api/apusic/v1.0/sms/{templateCode}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
吴昌达---获取模板名称的短信信息
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| templateCode | templateCode | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Sms |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createBy | string | ||
| createTime | string(date-time) | string(date-time) | |
| extendAttr | string | ||
| id | string | ||
| platform | string | ||
| sendCount | integer(int32) | integer(int32) | |
| smsCode | string | ||
| smsTemplateCode | string | ||
| status | integer(int32) | integer(int32) | |
| tenantId | string | ||
| updateBy | string | ||
| updateTime | string(date-time) | string(date-time) |
响应示例:
{
"createBy": "",
"createTime": "",
"extendAttr": "",
"id": "",
"platform": "",
"sendCount": 0,
"smsCode": "",
"smsTemplateCode": "",
"status": 0,
"tenantId": "",
"updateBy": "",
"updateTime": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 认证接口模块
# 添加LicenseLog
接口地址:/api/apusic/v1.0/license
请求方式:POST
请求数据类型:application/json
响应数据类型:application/json
接口描述:
陈晨---添加LicenseLog
请求示例:
{
"status": ""
}
1
2
3
2
3
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | 添加LicenseLog记录 | body | true | CertificateCreateRequest | CertificateCreateRequest |
| status | 0：证书到期30天之前，1：到期前30-15天，2：到期前15-1天，3：过期7天内,4:过期超过7天 | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«LicenseLogVO» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | LicenseLogVO | LicenseLogVO |
| createTime | 创建时间 | string(date-time) | |
| createdBy | 创建人 | string | |
| id | 主键id | string | |
| status | 0：证书到期30天之前，1：到期前30-15天，2：到期前15-1天，3：过期7天内，4:过期超过7天 | string | |
| updateBy | 修改人 | string | |
| updateTime | 修改时间 | string(date-time) | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {
"createTime": "",
"createdBy": "",
"id": "",
"status": "chen chen",
"updateBy": "",
"updateTime": ""
},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# readLicense
接口地址:/api/apusic/v1.0/license/readLicense
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
陈晨--认证信息的读取
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | LicenseDTO |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| connections | 连接数 | integer(int32) | integer(int32) |
| cpus | integer(int32) | integer(int32) | |
| datefrom | 有效时间 | integer(int64) | integer(int64) |
| dueDate | 有效期结束时间 | string(date-time) | string(date-time) |
| durationDays | 有效时间天数 | integer(int32) | integer(int32) |
| edition | 标准版、高级版 | string | |
| editionAlias | 标准版、高级版 | string | |
| expirationFlag | 是否有效期 | boolean | |
| extraAttrs | 额外值 | string | |
| licensee | 使用单位/公司 | string | |
| product | 产品 | string | |
| pwdFlag | 秘钥是否正确/认证是否有效 | boolean | |
| startDate | 有效期开始时间 | string(date-time) | string(date-time) |
| status | 0：认证无效，1：证书有效，2：未过期，3：已过期 | integer(int32) | integer(int32) |
| version | string |
响应示例:
{
"connections": 0,
"cpus": 0,
"datefrom": 0,
"dueDate": "",
"durationDays": 0,
"edition": "",
"editionAlias": "",
"expirationFlag": true,
"extraAttrs": "",
"licensee": "",
"product": "",
"pwdFlag": true,
"startDate": "",
"status": 0,
"version": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# remind
接口地址:/api/apusic/v1.0/license/remind
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
陈晨--到期状态：0：证书到期30天之前，1：到期前30-15天，2：到期前15-1天，3：过期7天内,4:过期超过7天
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Map«string,object»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# status
接口地址:/api/apusic/v1.0/license/status
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
陈晨--认证状态：0：认证无效，1：证书有效，2：未过期，3：已过期
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RestResponse«Map«string,object»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| data | 请求返回数据,请求成功时才有此字段 | object | |
| message | 请求结果描述 | string | |
| pageInfo | 分页信息 | 分页信息 | |
| current | 当前页数 | integer(int64) | |
| pages | 总页数 | integer(int64) | |
| size | 分页大小 | integer(int64) | |
| total | 总记录条数 | integer(int64) | |
| status | 请求状态码. status为0表示请求成功;非0表示请求发生错误,此时status为此错误的错误码. | integer(int32) | integer(int32) |
| timestamp | 时间戳 | integer(int64) | integer(int64) |
响应示例:
{
"data": {},
"message": "请求成功",
"pageInfo": {
"current": 2,
"pages": 4,
"size": 20,
"total": 62
},
"status": 0,
"timestamp": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
编辑页面 (opens new window)