<h1 class="curproject-name"> 用户中心 </h1>
用户信息管理
绑定二维码
基本信息
Path： /user2/user/bindQRCode
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| qrCodeId | string | 必须 | 二维码Id |
确认二维码
基本信息
Path： /user2/user/confirmQRLogin
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| qrCodeId | string | 必须 | 二维码Id |
取消二维码
基本信息
Path： /user2/user/cancelQRLogin
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| qrCodeId | string | 必须 | 二维码Id |
获取当前用户信息
基本信息
Path： /user2/user/curUser
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | 邮箱 | |||
| logo | string | 非必须 | 头像地址 | ||
| mobile | string | 非必须 | 手机号 | ||
| nickname | string | 非必须 | 昵称 | ||
| passwordFlag | boolean | 非必须 | 是否设置过密码 | ||
| username | string | 非必须 | 用户名 | ||
| boolean | 非必须 | 是否绑定qq | |||
| boolean | 非必须 | 是否绑定微信 | |||
| boolean | 非必须 | 是否绑定微博 | |||
| accountSystemKey | string | 非必须 | 账号体系Key | ||
| userUid | string | 必须 | 用户id |
用户名/手机号查找账户(非兼容修改，已沟通)
基本信息
Path： /user2/user/user
Method： GET
接口描述：
前端匹配传username或mobile，非手机号传username字段，手机号传mobile
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| username | 否 | String类型，用户名，用户名至少6个连续字符匹配查询 | |
| mobile | 否 | String类型，手机号，手机号需完全匹配查询 |
返回数据
传username或nickname时，返回List<UserVo>
[
{
"userUid": "979696989889009",
"username": "chenglin",
"nickname": null,
"mobile": null,
"email": null,
"accountSystemKey": "defat",
"logo": "drggeygt",
"passwordFlag": true,
"qq": false,
"wechat": false,
"weibo": false
}
]
}
传mobile时，返回List<UserVo>
[
{
"userUid": "979696989889009",
"username": "chenglin",
"nickname": null,
"mobile": 135676548790,
"email": null,
"accountSystemKey": "defat",
"logo": "drggeygt",
"passwordFlag": true,
"qq": false,
"wechat": false,
"weibo": false
}
]
获取用户的扩展信息（非兼容修改，已沟通）
基本信息
Path： /user2/user/userExtend
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| userUid | 是 | String类型，用户Id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| address | string | 非必须 | 街道地址 | ||
| area | string | 非必须 | 区代码 | ||
| birthday | string | 非必须 | 生日（Date类型） | format: date-time | |
| city | string | 非必须 | 城市代码 | ||
| string | 非必须 | 邮箱 | |||
| intro | string | 非必须 | 个人介绍 | ||
| logo | string | 非必须 | 头像地址 | ||
| province | string | 非必须 | 省份代码 | ||
| sex | string | 非必须 | 性别（0：男，1：女） | ||
| username | string | 非必须 | 用户名 | ||
| accountSystemKey | string | 必须 | 账号体系key | ||
| userUid | string | 必须 | 用户id | ||
| nickname | string | 非必须 | 昵称 |
设置当前用户的扩展信息（非兼容修改，已沟通）
基本信息
Path： /user2/user/setUserExtend
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| address | string | 非必须 | 街道地址，最长200个字符 | ||
| area | string | 非必须 | 区，20个字符 | ||
| birthday | string | 非必须 | 生日 swagger参数参考格式：Mon Oct 29 17:16:04 CST 2018 | format: date-time | |
| city | string | 非必须 | 市，20个字符 | ||
| intro | string | 非必须 | 个人简介，最长200个字符 | ||
| logo | string | 非必须 | 头像,200个字符 | ||
| province | string | 非必须 | 省，20个字符 | ||
| sex | string | 非必须 | 性别(填数字) 0：男， 1：女 | ||
| string | 非必须 | 50个字符 |
设置当前用户的用户名（新增接口）
基本信息
Path： /user2/user/setUsername
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| username | string | 必须 | 用户名，仅支持6-30位大小写字母、数字和下划线，且必须包含字母 |
设置当前用户的密码(非兼容修改，已沟通)
基本信息
Path： /user2/user/setPassword
Method： POST
接口描述：
手机号注册的用户设置密码调用此接口，code和messageId传注册时的信息。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| messageId | string | 必须 | 验证码Id | ||
| password | string | 必须 | 密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| smsCode | string | 必须 | 验证码，6位数字 |
修改当前用户的昵称（非兼容修改，已沟通）
基本信息
Path： /user2/user/nickname
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| nickname | string | 必须 | 昵称，最长30个字符 |
修改当前用户密码-旧密码方式（非兼容修改）
基本信息
Path： /user2/user/password
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| oldPwd | string | 必须 | 旧密码 | ||
| newPwd | string | 必须 | 新密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& |
修改当前用户密码-短信验证码方式（非兼容修改，已沟通）
基本信息
Path： /user2/user/resetPasswordByMobile
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| messageId | string | 必须 | 短信验证码Id | ||
| smsCode | string | 必须 | 短信验证码 | ||
| newPwd | string | 必须 | 新密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& |
修改当前用户密码-密保方式（非兼容修改）
基本信息
Path： /user2/user/resetPasswordByQuestion
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| questionId | string | 必须 | 密保问题Id | ||
| answer | string | 必须 | 密保答案 | ||
| newPwd | string | 必须 | 新密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& |
给当前用户绑定手机号(非兼容修改，已沟通)
基本信息
Path： /user2/user/bindMobile
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appPrefix | string | 必须 | 应用前缀（极光使用） | ||
| messageId | string | 必须 | 短信验证码Id | ||
| smsCode | string | 必须 | 短信验证码 | ||
| phoneNo | string | 必须 | 手机号码 |
更换当前用户已绑定的手机号(非兼容修改，已沟通)
基本信息
Path： /user2/user/changeMobile
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| newSmsCode | object | 必须 | 新手机信息 | ||
| ├─ appPrefix | string | 必须 | 应用前缀 | ||
| ├─ messageId | string | 必须 | 短信验证码Id | ||
| ├─ phoneNo | string | 必须 | 手机号码 | ||
| ├─ smsCode | string | 必须 | 验证码 | ||
| oldSmsCode | object | 必须 | 旧手机信息 | ||
| ├─ appPrefix | string | 必须 | 应用前缀 | ||
| ├─ phoneNo | string | 必须 | 手机号码 | ||
| ├─ messageId | string | 必须 | 短信验证码Id | ||
| ├─ smsCode | string | 必须 | 验证码 |
获取当前用户已设置的密保问题
基本信息
Path： /user2/user/myQuestion
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ id | integer | 必须 | 密保问题id | format: int64 | |
| ├─ question | string | 必须 | 密保问题 |
获取系统密保问题列表
基本信息
Path： /user2/user/questionList
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ id | integer | 必须 | 密保问题Id | format: int64 | |
| ├─ question | string | 必须 | 密保答案 |
设置密保问题答案（非兼容修改）
基本信息
Path： /user2/user/questionAnswer
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| questionId | string | 必须 | 密保问题Id | ||
| answer | string | 必须 | 密保问题答案，不超过50个字符 |
校验密保问题答案（非兼容修改）
基本信息
Path： /user2/user/checkQuestion
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| answer | string | 必须 | 密保问题答案 | ||
| questionId | string | 必须 | 密保问题Id |
修改密保问题(非兼容修改)
基本信息
Path： /user2/user/resetQuestionAnswer
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| oldQuestionId | string | 必须 | 旧密保问题id | ||
| newQuestionId | string | 必须 | 新密保问题 | ||
| answer | string | 必须 | 新密保答案，不超过50个字符 |
绑定社交账号【绑定类型支持小程序/微信/微博/QQ】（非兼容修改，已沟通）
基本信息
Path： /user2/user/bindSocialAccount
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| socialAccountKey | string | 必须 | 社交账号key | ||
| socialAccountType | string | 必须 | 社交账号类型，微信小程序填miniProgram，App微信登录填wechat |
解绑当前用户的社交账号【解绑类型支持微信/微博/QQ/所有小程序】（非兼容修改）
基本信息
Path： /user2/user/unbindSocialAccount
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| socialAccountType | string | 必须 | socialAccountType |
重置指定用户的密码（非兼容修改）
基本信息
Path： /user2/user/resetPassword
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| userUid | 是 | 用户Id |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | 生成的随机密码 |
批量注册用户名密码注册（非兼容修改）
基本信息
Path： /user2/user/registerUserInBulk
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| accountSystemKey | string | 必须 | 账号体系Key | ||
| batchUserVos | object [] | 必须 | 用户名和密码列表 | item 类型: object | |
| ├─ password | string | 必须 | 密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| ├─ username | string | 必须 | 用户名，仅支持6-30位大小写字母、数字和下划线，且必须包含字母 |
获取父账户Id（非兼容修改）
基本信息
Path： /user2/user/getParentUserUid
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | 父账户Id |
创建子账户（非兼容修改）
基本信息
Path： /user2/user/createChildUser
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| password | string | 必须 | 密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| username | string | 必须 | 用户名，仅支持6-30位大小写字母、数字和下划线，且必须包含字母 | ||
| nickname | string | 非必须 | 昵称，不大于30个字符 |
获取子账户列表【子账户管理授权页使用】
基本信息
Path： /user2/user/pageMyChildAccount
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| sort | 否 | username,desc | array[Stgring]类型，排序相关的信息（排序标准的格式为：property（，asc |
| page | 否 | 3 | Interger类型，第几页，从0开始，默认为第0页.您要检索的结果页面（0…N） |
| size | 否 | 30 | Interger类型，每一页的大小，默认为10 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| content | object [] | 非必须 | item 类型: object | ||
| ├─ activated | boolean | 必须 | 用户状态 | ||
| ├─ userAppAuthorityVO | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 必须 | 应用Key | ||
| ├─ appName | string | 必须 | 应用名称 | ||
| ├─ authorities | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 非必须 | 应用前缀 | ||
| ├─ authorityKey | string | 非必须 | 功能key | ||
| ├─ description | string | 非必须 | 功能描述 | ||
| ├─ name | string | 非必须 | 功能名称 | ||
| ├─ parent | string | 非必须 | 父节点(暂时不用) | ||
| ├─ authorityGroups | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 非必须 | 应用id | ||
| ├─ authorityEntities | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 非必须 | 应用Key | ||
| ├─ authorityKey | string | 非必须 | 功能Key | ||
| ├─ description | string | 非必须 | 功能描述 | ||
| ├─ name | string | 非必须 | 功能名称 | ||
| ├─ parent | string | 非必须 | 父节点(暂时不用) | ||
| ├─ authorityGroupKey | string | 必须 | 角色key | ||
| ├─ authorityGroupName | string | 必须 | 角色名称 | ||
| ├─ authorityGroupParent | string | 非必须 | 角色父节点 | ||
| ├─ children | string [] | 非必须 | item 类型: string | ||
| ├─ | 非必须 | ||||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ username | string | 必须 | 用户名 | ||
| ├─ userUid | string | 必须 | |||
| first | boolean | 非必须 | |||
| last | boolean | 非必须 | |||
| number | integer | 非必须 | format: int32 | ||
| numberOfElements | integer | 非必须 | format: int32 | ||
| pageable | object | 非必须 | |||
| ├─ page | integer | 非必须 | Results page you want to retrieve (0..N) | format: int32 | |
| ├─ size | integer | 非必须 | Number of records per page | format: int32 | |
| ├─ sort | string [] | 非必须 | Sorting criteria in the format: property(,asc | desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| ├─ | 非必须 | ||||
| size | integer | 非必须 | format: int32 | ||
| sort | object | 非必须 | |||
| ├─ sorted | boolean | 非必须 | |||
| ├─ unsorted | boolean | 非必须 | |||
| totalElements | integer | 非必须 | format: int64 | ||
| totalPages | integer | 非必须 | format: int32 |
修改子账户状态（非兼容修改）
基本信息
Path： /user2/user/changeUserStatus
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| activated | boolean | 必须 | 用户状态 | ||
| userUid | string | 必须 | 用户Id |
修改子账户的密码（新增接口）
基本信息
Path： /user2/user/updateChildPassword
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| newPassword | string | 必须 | 新密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| userUid | string | 必须 | 用户名Id |
创建指定账户的子账户【流程定制特供】
基本信息
Path： /user2/user/createSpecifiedChild
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| username | string | 必须 | 用户名 | ||
| accountSystemKey | string | 必须 | 账号体系Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
创建指定账户的子账户（通过用户id）【流程定制特供
基本信息
Path： /user2/user/createSpecifiedChildByUserUid
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| userUid | string | 必须 | 用户Id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
创建当前账户的随机子账户【流程定制特供】
基本信息
Path： /user2/user/creatRandomChild
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | 返回String类型的子账户id |
指定账户获取token【流程定制特供】
基本信息
Path： /user2/user/getToken
Method： GET
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Authorization | client-id和client-secret拼装后Base64的值 | 是 | 默认：Basic c3NvLWdhdGV3YXk6c3NvLWdhdGV3YXktc2VjcmV0 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| userUid | 是 | 子账户Id | |
| grant_type | 是 | password | 权限参数 |
| scope | 是 | read | 权限参数 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| grant_type | string | 必须 | 授权模式 | ||
| refresh_token | string | 必须 | 刷新t的oken |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | access_token |
检查用户是否注册（新增接口）
基本信息
Path： /user2/user/checkAndRegister
Method： GET
接口描述：
<span class="colour" style="color:rgb(51, 51, 51)">第三方系统，若不对接用户中心，使用本接口默认为指定用户注册</span>
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| username | 是 | 用户名，用户名至少6个连续字符匹配查询 | |
| accountSystemkey | 是 | 账户体系Key，不大于五个小写字母 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | 用户Id |
公共分类【外部调用】
忘记密码-通过手机号找回密码
基本信息
Path： /user2/public/forgetPassword
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| Authorization | client-id和client-secret拼装后Base64的值 | 是 | 默认：Basic c3NvLWdhdGV3YXk6c3NvLWdhdGV3YXktc2VjcmV0 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| mobile | string | 必须 | 手机号 | ||
| messageId | string | 必须 | 短信验证码Id | ||
| smsCode | string | 必须 | 短信验证码 | ||
| newPwd | string | 必须 | 新密码，仅支持8~20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| accountSystemKey | string | 必须 | 账号体系Key | ||
| appPrefix | string | 必须 | 极光应用前缀 |
账户体系管理
新建账号体系(新增接口)
基本信息
Path： /user2/accountAdmin/createAccountSystem
Method： POST
接口描述：
accountSystemKey全局唯一，accountSystemName可以不唯一。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| accountSystemKey | string | 必须 | 账户体系Key，仅支持小写英文字母，支持2-5个字符 | ||
| accountSystemName | string | 必须 | 账户体系名称，30个字符 | ||
| openRegister | boolean | 必须 | 是否开放注册，默认为true | ||
| accountStatus | boolean | 必须 | 账号体系状态，默认为true |
修改账号体系(新增接口)
基本信息
Path： /user2/accountAdmin/updateAccountSystem
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| accountSystemKey | string | 必须 | 账户体系Key，不允许修改 | ||
| accountSystemName | string | 必须 | 账户体系名称，最长30个字符 | ||
| openRegister | boolean | 必须 | 是否开放注册 |
修改账号体系状态(新增接口)
基本信息
Path： /user2/accountAdmin/updateAccountSystemStatus
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| accountSystemKey | string | 必须 | 账号体系Key，不允许修改 | ||
| accountStatus | boolean | 必须 | 账号体系状态 |
获取当前用户所创建的所有账号体系(新增接口)
基本信息
Path： /user2/accountAdmin/pageAccountSystems
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| sort | 否 | accountSystemKey,desc | array[Stgring]类型，排序相关的信息（排序标准的格式为：property（，asc |
| page | 否 | 3 | Interger类型，第几页，从0开始，默认为第0页.您要检索的结果页面（0…N） |
| size | 否 | 30 | Interger类型，每一页的大小，默认为10 |
| keyword | 否 | "coo" | String类型，模糊查询体系信息 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| content | object [] | 非必须 | item 类型: object | ||
| ├─ accountSystemKey | string | 必须 | 账户体系Key | ||
| ├─ accountSystemName | string | 必须 | 账户体系名称 | ||
| ├─ creator | string | 必须 | 账户体系创建者 | ||
| ├─ accountStatus | string | 必须 | 账户体系状态 | ||
| ├─ openRegister | boolean | 必须 | 账户体系是否开放注册 | ||
| ├─ creatTime | object | 必须 | Date类型体系创建时间 | ||
| first | boolean | 非必须 | |||
| last | boolean | 非必须 | |||
| number | integer | 非必须 | format: int32 | ||
| numberOfElements | integer | 非必须 | format: int32 | ||
| pageable | object | 非必须 | |||
| ├─ page | integer | 非必须 | Results page you want to retrieve (0..N) | format: int32 | |
| ├─ size | integer | 非必须 | Number of records per page | format: int32 | |
| ├─ sort | string [] | 非必须 | Sorting criteria in the format: property(,asc | desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| ├─ | 非必须 | ||||
| size | integer | 非必须 | format: int32 | ||
| sort | object | 非必须 | |||
| ├─ sorted | boolean | 非必须 | |||
| ├─ unsorted | boolean | 非必须 | |||
| totalElements | integer | 非必须 | format: int64 | ||
| totalPages | integer | 非必须 | format: int32 |
创建体系下的用户(新增接口)
基本信息
Path： /user2/accountAdmin/creatUserUnderAccountSystem
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| accountSystemKey | string | 必须 | 账号体系Key | ||
| username | string | 必须 | 用户名，仅支持6-30位大小写字母、数字和下划线，且必须包含字母 | ||
| password | string | 必须 | 密码，仅支持8-20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| nickname | string | 非必须 | 昵称，昵称，长度范围为1-30个字符！ |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 必须 | 用户ID |
修改体系下用户状态/密码(新增接口)
基本信息
Path： /user2/accountAdmin/updateUserStatus
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| username | string | 必须 | 用户名 | ||
| accountSystemKey | string | 必须 | 账号体系Key | ||
| activated | boolean | 必须 | 是否激活 | ||
| restPwd | string | 非必须 | 新密码，仅支持8-20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& |
获取账号体系下的所有用户(新增接口)（dev2）
基本信息
Path： /user2/accountAdmin/pageAccountSystemUsers
Method： GET
接口描述：
Pagebale参数是Spring-data-commons默认的类型。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| sort | 否 | username,desc | array[Stgring]类型，排序相关的信息（排序标准的格式为：property（，asc |
| page | 否 | 3 | Interger类型，第几页，从0开始，默认为第0页.您要检索的结果页面（0…N） |
| size | 否 | 30 | Interger类型，每一页的大小，默认为10 |
| accountSystemKey | 是 | "cook" | String类型，账户体系,智厨默认体系为"cook" |
| mobile | 否 | "13456767866" | String类型，手机号精确查询 |
| username | 否 | "nihaoma" | String类型，用户名精确查询 |
| nicknameLike | 否 | "" | String类型，昵称模糊查询 |
| usernameLike | 否 | String类型，用户名模糊查询 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| content | object [] | 非必须 | item 类型: object | ||
| ├─ logo | string | 非必须 | 头像地址 | ||
| ├─ nickname | string | 非必须 | 昵称 | ||
| ├─ userUid | string | 必须 | 用户Id | ||
| ├─ username | string | 非必须 | 用户名 | ||
| ├─ mobile | string | 非必须 | 手机号 | ||
| ├─ activated | string | 必须 | 用户状态 | ||
| ├─ accountSystemKey | string | 必须 | 账户体系key | ||
| ├─ password | string | 非必须 | 密码，为null | ||
| ├─ createdDate | object | 必须 | Date类型，创建时间 | ||
| first | boolean | 非必须 | |||
| last | boolean | 非必须 | |||
| number | integer | 非必须 | format: int32 | ||
| numberOfElements | integer | 非必须 | format: int32 | ||
| pageable | object | 非必须 | |||
| ├─ page | integer | 非必须 | Results page you want to retrieve (0..N) | format: int32 | |
| ├─ size | integer | 非必须 | Number of records per page | format: int32 | |
| ├─ sort | string [] | 非必须 | Sorting criteria in the format: property(,asc | desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| ├─ | 非必须 | ||||
| size | integer | 非必须 | format: int32 | ||
| sort | object | 非必须 | |||
| ├─ sorted | boolean | 非必须 | |||
| ├─ unsorted | boolean | 非必须 | |||
| totalElements | integer | 非必须 | format: int64 | ||
| totalPages | integer | 非必须 | format: int32 |
批量获取体系下的用户(新增接口）（dev2）
基本信息
Path： /user2/accountAdmin/listUserInfo
Method： GET
接口描述：
Pagebale参数是Spring-data-commons默认的类型。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| accountSystemKey | 是 | "cook" | String类型，账户体系,智厨默认体系为"cook" |
| usernameList | 是 | "chengbaobao,yaobaobao" | List<String>类型，用户名列表 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ logo | string | 非必须 | 头像地址 | ||
| ├─ nickname | string | 非必须 | 昵称 | ||
| ├─ userUid | string | 必须 | 用户Id | ||
| ├─ username | string | 非必须 | 用户名 | ||
| ├─ mobile | string | 非必须 | 手机号 | ||
| ├─ activated | string | 必须 | 用户状态 | ||
| ├─ accountSystemKey | string | 必须 | 账户体系key | ||
| ├─ password | string | 非必须 | 密码，为null | ||
| ├─ createdDate | object | 必须 | Date类型，创建时间 |
功能Key和体系Key查询用户（新增接口）
基本信息
Path： /user2/accountAdmin/getAllUsernameByAuthority
Method： GET
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | String类型，appKey | |
| authorityKey | 是 | String类型，功能Key | |
| accountSystemKey | 否 | String类型，账号体系key |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appkey | string | 必须 | 应用Key | ||
| authorityKey | string | 必须 | 功能Key | ||
| accountSystemKey | string | 非必须 | 账户体系Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ userUid | string | 必须 | |||
| ├─ username | string | 非必须 | |||
| ├─ logo | string | 非必须 | 头像地址 | ||
| ├─ nickname | string | 非必须 | |||
| ├─ appkey | string | 必须 | |||
| ├─ authorityKey | string | 必须 | 功能key | ||
| ├─ accountSystemKey | string | 必须 | 账户体系Key |
角色Key和体系Key查询用户（新增接口）
基本信息
Path： /user2/accountAdmin/getAllUsernameByAuthorityGroup
Method： GET
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| accountSystemKey | 否 | String类型，账户体系key | |
| appKey | 是 | String类型，应用key | |
| authorityGroupKey | 是 | String类型，角色Key |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appkey | string | 必须 | 应用Key | ||
| authorityGroupKey | string | 必须 | 角色Key | ||
| accountSystemKey | string | 非必须 | 账户体系Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ userUid | string | 必须 | |||
| ├─ username | string | 非必须 | |||
| ├─ logo | string | 非必须 | 头像地址 | ||
| ├─ nickname | string | 非必须 | 昵称 | ||
| ├─ appkey | string | 必须 | 应用key' | ||
| ├─ authorityGroupKey | string | 必须 | 角色key | ||
| ├─ accountSystemKey | string | 必须 | 体系key |
创建体系下的用户(餐饮管理员)
基本信息
Path： /user2/accountAdmin/creatAccount
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| accountSystemKey | string | 必须 | 账号体系Key | ||
| username | string | 必须 | 用户名，仅支持6-30位大小写字母、数字和下划线，且必须包含字母 | ||
| password | string | 必须 | 密码，仅支持8-20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| nickname | string | 非必须 | 昵称，长度范围为1-30个字符！ | ||
| logo | string | 非必须 | 头像路径 | ||
| mobile | string | 非必须 | 手机号 | ||
| activated | string | 非必须 | 账户是否激活 | ||
| accountAuthorityGroupVO | object | 非必须 | 角色信息 | ||
| ├─ appKey | string | 非必须 | 应用key | ||
| ├─ authorityGroupKey | string | 非必须 | 角色Key | ||
| ├─ authorityGroupName | string | 非必须 | 角色名称 |
修改体系下指定用户信息/修改密码（餐饮管理员特供）
基本信息
Path： /user2/accountAdmin/updateUserInfo
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| accountSystemKey | string | 必须 | 账号体系Key | ||
| username | string | 必须 | 用户名 | ||
| password | string | 非必须 | 密码，仅支持8-20位，至少包含一个大写字母，一个小写字母，一各数字，可选特殊字符￥@！%*#？& | ||
| nickname | string | 非必须 | 昵称，长度范围为1-30个字符！ | ||
| logo | string | 非必须 | 头像路径 | ||
| mobile | string | 非必须 | 手机号 | ||
| activated | string | 非必须 | 账户是否激活 | ||
| accountAuthorityGroupVO | object | 非必须 | 角色信息 | ||
| ├─ appkey | string | 非必须 | 应用key | ||
| ├─ authorityGroupKey | string | 非必须 | 角色Key | ||
| ├─ authorityGroupName | string | 非必须 | 角色名称 |
应用管理
获取应用列表（兼容修改）
基本信息
Path： /user2/app/apps
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| sort | 否 | appKey,desc | array[Stgring]类型，排序相关的信息（排序标准的格式为：property（，asc |
| page | 否 | 2 | Interger类型，第几页，从0开始，默认为第0页.您要检索的结果页面（0…N） |
| size | 否 | 30 | Interger类型，每一页的大小，默认为10 |
| keyword | 否 | 应用名称模糊查询应用信息 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| content | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 非必须 | 应用Key | ||
| ├─ createdDate | object | 非必须 | 应用创建日期，Date类型 | ||
| ├─ description | string | 非必须 | 应用描述 | ||
| ├─ developer | string | 非必须 | 应用开发者 | ||
| ├─ name | string | 非必须 | 应用名称 | ||
| ├─ status | boolean | 非必须 | 应用状态:true-启用，false-禁用 | ||
| first | boolean | 非必须 | |||
| last | boolean | 非必须 | |||
| number | integer | 非必须 | format: int32 | ||
| numberOfElements | integer | 非必须 | format: int32 | ||
| pageable | object | 非必须 | |||
| ├─ page | integer | 非必须 | Results page you want to retrieve (0..N) | format: int32 | |
| ├─ size | integer | 非必须 | Number of records per page | format: int32 | |
| ├─ sort | string [] | 非必须 | Sorting criteria in the format: property(,asc | desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| ├─ | 非必须 | ||||
| size | integer | 非必须 | format: int32 | ||
| sort | object | 非必须 | |||
| ├─ sorted | boolean | 非必须 | |||
| ├─ unsorted | boolean | 非必须 | |||
| totalElements | integer | 非必须 | format: int64 | ||
| totalPages | integer | 非必须 | format: int32 |
新建应用(非兼容修改)
基本信息
Path： /user2/app/app
Method： POST
接口描述：
appKey全局唯一，name可以不唯一。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key，仅小写字母数字，最长30字符 | ||
| description | string | 非必须 | 应用描述，最长200个字符 | ||
| name | string | 必须 | 应用名称：最长30个字符 | ||
| status | boolean | 非必须 | 应用状态 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
修改应用信息(非兼容修改)
基本信息
Path： /user2/app/updateAppInfo
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key，不允许修改 | ||
| description | string | 非必须 | 应用描述：最长200个字符 | ||
| name | string | 必须 | 应用名称：最长30个字符 |
修改应用状态(非兼容修改)
基本信息
Path： /user2/app/appStatus
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key，不允许修改 | ||
| status | boolean | 必须 | 应用状态 |
获取每个应用下的功能数据量以及用户数量
基本信息
Path： /user2/listNumberPerApp
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKeys | 是 | String 类型，应用Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ authoritiesNumber | integer | 必须 | 应用下的功能数量 | ||
| ├─ authoritGroupsNumber | integer | 必须 | 应用下的角色数量 | ||
| ├─ relateUsersNumber | integer | 必须 | 拥有应用权限的用户数量 |
获取用户数量（不与应用关联）每个应用下的功能数量以及用户数量
基本信息
Path： /user2/admin/listNumberPerApp
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| numberPerAppVOs | object [] | 必须 | item 类型: object | ||
| ├─ authoritiesNumber | integer | 必须 | 应用下的功能数量 | ||
| ├─ authoritGroupsNumber | integer | 必须 | 应用下的角色数量 | ||
| ├─ relateUsersNumber | integer | 必须 | 拥有应用权限的用户数量 | ||
| unRelatedUsersNumber | number | 必须 | Long类型，未被授权过的用户数量 |
功能管理
新增功能
基本信息
Path： /user2/authority
Method： POST
接口描述：
authorityKey应用下唯一，name可以不唯一
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| authorityKey | string | 必须 | 功能Key:大小写字母、数字和下划线，长度81个字符（其中前缀占31个字符） | ||
| description | string | 非必须 | 功能描述：最长200个字符 | ||
| name | string | 必须 | 能名称：最长30个字符 |
删除功能-删除关联关系(非兼容修改)
基本信息
Path： /user2/deleteAuthority
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| authorityKey | string | 必须 | 功能Key |
编辑功能(新增接口)
基本信息
Path： /user2/updateAuthority
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key，不允许修改 | ||
| authorityKey | string | 必须 | 功能Key，不允许修改 | ||
| description | string | 非必须 | 功能描述，最长200个字符 | ||
| name | string | 必须 | 功能名称，最长30个字符 |
查询应用下功能列表（兼容性修改）
基本信息
Path： /user2/authorities
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| sort | 否 | appkey,desc | array[Stgring]类型，排序相关的信息（排序标准的格式为：property（，asc |
| page | 否 | 3 | Interger类型，第几页，从0开始，默认为第0页.您要检索的结果页面（0…N） |
| size | 否 | 30 | Interger类型，每一页的大小，默认为10 |
| appKey | 是 | String类型，应用Key | |
| keyword | 否 | String类型，模糊查询功能信息 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| content | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 必须 | 应用前缀(前端回填) | ||
| ├─ authorityKey | string | 必须 | 功能key | ||
| ├─ description | string | 非必须 | 功能描述 | ||
| ├─ name | string | 必须 | 功能名称 | ||
| ├─ parent | string | 非必须 | 父节点(暂时不用) | ||
| first | boolean | 非必须 | |||
| last | boolean | 非必须 | |||
| number | integer | 非必须 | format: int32 | ||
| numberOfElements | integer | 非必须 | format: int32 | ||
| pageable | object | 非必须 | |||
| ├─ page | integer | 非必须 | Results page you want to retrieve (0..N) | format: int32 | |
| ├─ size | integer | 非必须 | Number of records per page | format: int32 | |
| ├─ sort | string [] | 非必须 | Sorting criteria in the format: property(,asc | desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| ├─ | 非必须 | ||||
| size | integer | 非必须 | format: int32 | ||
| sort | object | 非必须 | |||
| ├─ sorted | boolean | 非必须 | |||
| ├─ unsorted | boolean | 非必须 | |||
| totalElements | integer | 非必须 | format: int64 | ||
| totalPages | integer | 非必须 | format: int32 |
查询应用下的功能Key列表【Feign】
基本信息
Path： /user2/getAuthoritiesByApp
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | String类型，应用Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string [] | 非必须 | item 类型: string | |||
| ├─ | 非必须 | 功能key列表 |
角色管理
获取角色树
基本信息
Path： /user2/authorityGroup
Method： GET
接口描述：
获取所创建的指定应用下的角色树，或者获取所创建的指定应用指定角色下的角色树
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | String类型，应用Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ appKey | string | 非必须 | 应用id | ||
| ├─ authorityEntities | object [] | 非必须 | item 类型: object | ||
| ├─ authorityKey | string | 必须 | |||
| ├─ name | string | 必须 | |||
| ├─ description | string | 必须 | |||
| ├─ parent | string | 必须 | |||
| ├─ appKey | string | 必须 | |||
| ├─ authorityGroupKey | string | 必须 | 角色key，规则：应用key_角色英文名，如：iot_manager | ||
| ├─ authorityGroupName | string | 必须 | 角色名称 | ||
| ├─ authorityGroupParent | string | 非必须 | 角色父节点 | ||
| ├─ children | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 必须 | |||
| ├─ authorityGroupKey | string | 必须 | |||
| ├─ authorityGroupName | string | 必须 | |||
| ├─ authorityGroupParent | string | 必须 | |||
| ├─ authorityEntities | object [] | 必须 | item 类型: object | ||
| ├─ children | object [] | 必须 | item 类型: object | ||
| ├─ description | string | 非必须 | 角色描述 |
新增角色（非兼容修改）
基本信息
Path： /user2/authorityGroup
Method： POST
接口描述：
authorityGroupKey应用下唯一，authorityGroupName可以不唯一。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| authorityGroupKey | string | 必须 | 角色Key:大小写字母、数字和下划线，长度81个字符（其中前缀占31个字符） | ||
| authorityGroupName | string | 必须 | 角色名称，最长30个字符 | ||
| authorityGroupParent | string | 非必须 | 父角色Key | ||
| description | string | 非必须 | 角色描述，最长200个字符 |
删除叶子角色(非兼容修改)
基本信息
Path： /user2/deleteAuthorityGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| authorityGroupKey | string | 必须 | 角色Key |
修改角色名(非兼容修改)
基本信息
Path： /user2/updateAuthorityGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| authGroupKey | string | 必须 | 角色Key，不允许修改 | ||
| newName | string | 必须 | 新的角色名，最长30个字符 | ||
| description | string | 非必须 | 角色描述，最长200个字符 |
角色绑定功能(非兼容修改)
基本信息
Path： /user2/bindAuth2AuthGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| authorityGroupKey | string | 必须 | 角色Key | ||
| authorityKeys | string [] | 必须 | 功能key列表 | item 类型: string | |
| ├─ | 非必须 | 不能为空 |
角色解绑功能（新增接口）
基本信息
Path： /user2/unbindAuth2AuthGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| authorityGroupKey | string | 必须 | 角色Key | ||
| authorityKeys | string [] | 必须 | 功能key列表 | item 类型: string | |
| ├─ | 非必须 |
获取指定应用的角色列表
基本信息
Path： /user2/listAuthorityGroups
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | String类型，应用Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | 角色列表 | item 类型: object | ||
| ├─ authorityGroupKey | string | 必须 | 角色key | ||
| ├─ authorityGroupName | string | 必须 | 角色名 | ||
| ├─ authorityGroupParent | string | 必须 | 父角色key | ||
| ├─ description | string | 必须 | 描述 | ||
| ├─ appKey | string | 必须 | 应用key | ||
| ├─ authorityEntities | object [] | 必须 | 角色绑定的功能信息 | item 类型: object | |
| ├─ authorityKey | string | 必须 | 功能key | ||
| ├─ name | string | 必须 | 功能名 | ||
| ├─ description | string | 必须 | 描述 | ||
| ├─ parent | string | 必须 | 父功能名（暂不使用） | ||
| ├─ appKey | string | 必须 | 应用key | ||
| ├─ children | object [] | 必须 | 子角色信息 | item 类型: object | |
| ├─ authorityGroupKey | string | 必须 | 角色key | ||
| ├─ authorityGroupName | string | 必须 | 角色名 | ||
| ├─ authorityGroupParent | string | 必须 | 父角色key | ||
| ├─ description | string | 必须 | 描述 | ||
| ├─ appKey | string | 必须 | 应用key | ||
| ├─ authorityEntities | object [] | 必须 | item 类型: object | ||
| ├─ children | object [] | 必须 | item 类型: object |
获取角色Key列表【Feign】
基本信息
Path： /user2/getAuthorityGroupsByApp
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | String类型，应用Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string [] | 非必须 | item 类型: string | |||
| ├─ | 非必须 |
获取角色绑定的功能【Feign】
基本信息
Path： /user2/getAuthsByAuthGroupKeys
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | String类型，应用Key | |
| authGroupKey | 是 | String类型，角色Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string [] | 非必须 | item 类型: string | |||
| ├─ | 非必须 |
权限分配管理
分配功能(非兼容修改)
基本信息
Path： /user2/userAuth
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityKeys | string [] | 必须 | 功能key列表 | item 类型: string | |
| ├─ | 非必须 | 不能为空 |
分配角色(非兼容修改)
基本信息
Path： /user2/userAuthGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityGroupKeys | string [] | 必须 | 角色key列表 | item 类型: string | |
| ├─ | 非必须 | 不能为空 |
回收功能(新增接口)
基本信息
Path： /user2/unBindUserAuth
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityKeys | string [] | 必须 | 功能Key列表 | item 类型: string | |
| ├─ | 非必须 |
回收角色(新增接口)
基本信息
Path： /user2/unBindUserAuthGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityGroupKeys | string [] | 必须 | 角色Key列表 | item 类型: string | |
| ├─ | 非必须 |
给子账户分配功能(新增接口)
基本信息
Path： /user2/bindChildAuth
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityKeys | string [] | 必须 | 功能Key列表 | item 类型: string | |
| ├─ | 非必须 | 不能为空 |
给子账户分配角色(新增接口)
基本信息
Path： /user2/bindChildAuthGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityGroupKeys | string [] | 必须 | 角色key列表 | item 类型: string | |
| ├─ | 非必须 | 不能为空 |
回收子账户功能(新增接口)
基本信息
Path： /user2/unBindChildAuth
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityKeys | string [] | 必须 | 功能Key列表 | item 类型: string | |
| ├─ | 非必须 |
回收子账户角色(新增接口)
基本信息
Path： /user2/unBindChildAuthGroup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| appKey | string | 必须 | 应用Key | ||
| userUid | string | 必须 | 用户Id | ||
| authorityGroupKeys | string [] | 必须 | 角色Key列表 | item 类型: string | |
| ├─ | 非必须 |
获取指定应用已授权的用户列表【应用管理授权页】
基本信息
Path： /user2/pageAllAuthorities
Method： GET
接口描述：
具有该接口权限的用户，可以获取任意应用已授权的用户列表。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| sort | 否 | username,desc |
array[Stgring]类型，排序相关的信息（排序标准的格式为：property（，asc |
| page | 否 | 1 | Interger类型，第几页，从0开始，默认为第0页.您要检索的结果页面（0…N） |
| size | 否 | 30 | Interger类型，每一页的大小，默认为10 |
| appKey | 是 | String类型，应用Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| content | object [] | 非必须 | item 类型: object | ||
| ├─ activated | boolean | 必须 | 用户状态 | ||
| ├─ loginName | string | 必须 | 登录名 | ||
| ├─ userAppAuthorityVO | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 必须 | 应用Key | ||
| ├─ appName | string | 必须 | 应用名称 | ||
| ├─ authorities | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 非必须 | 应用前缀(前端回填) | ||
| ├─ authorityKey | string | 非必须 | 角色key，规则：应用key_角色英文名，如：iot_deleteOrder | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ name | string | 非必须 | 角色中文名 | ||
| ├─ parent | string | 非必须 | 父节点(暂时不用) | ||
| ├─ authorityGroups | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 非必须 | 应用id | ||
| ├─ authorityEntities | object [] | 非必须 | item 类型: object | ||
| ├─ appKey | string | 非必须 | 应用前缀(前端回填) | ||
| ├─ authorityKey | string | 非必须 | 角色key，规则：应用key_角色英文名，如：iot_deleteOrder | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ name | string | 非必须 | 角色中文名 | ||
| ├─ parent | string | 非必须 | 父节点(暂时不用) | ||
| ├─ authorityGroupKey | string | 必须 | 角色组key，规则：应用key_角色组英文名，如：iot_manager | ||
| ├─ authorityGroupName | string | 必须 | 角色组中文名 | ||
| ├─ authorityGroupParent | string | 非必须 | 角色组父节点 | ||
| ├─ children | string [] | 非必须 | item 类型: string | ||
| ├─ | 非必须 | ||||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ username | string | 必须 | 用户名 | ||
| first | boolean | 非必须 | |||
| last | boolean | 非必须 | |||
| number | integer | 非必须 | format: int32 | ||
| numberOfElements | integer | 非必须 | format: int32 | ||
| pageable | object | 非必须 | |||
| ├─ page | integer | 非必须 | Results page you want to retrieve (0..N) | format: int32 | |
| ├─ size | integer | 非必须 | Number of records per page | format: int32 | |
| ├─ sort | string [] | 非必须 | Sorting criteria in the format: property(,asc | desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| ├─ | 非必须 | ||||
| size | integer | 非必须 | format: int32 | ||
| sort | object | 非必须 | |||
| ├─ sorted | boolean | 非必须 | |||
| ├─ unsorted | boolean | 非必须 | |||
| totalElements | integer | 非必须 | format: int64 | ||
| totalPages | integer | 非必须 | format: int32 |
获取指定用户的权限集
基本信息
Path： /user2/listUserAuthorities
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | Stringl类型，应用Key | |
| userUid | 是 | String类型，用户Id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| userUid | string | 必须 | 用户Id | ||
| username | string | 必须 | 用户名 | ||
| accountSystemKey | string | 必须 | 账户体系Key | ||
| nickname | string | 非必须 | 昵称 | ||
| activated | string | 必须 | 用户状态 | ||
| userAppAuthorityVO | object | 非必须 | 用户权限列表 | ||
| ├─ appKey | string | 必须 | 应用key | ||
| ├─ appName | string | 必须 | 应用名称 | ||
| ├─ authorities | object | 非必须 | 用户功能集合 | ||
| ├─ appKey | string | 必须 | |||
| ├─ authorityKey | string | 必须 | |||
| ├─ description | string | 必须 | |||
| ├─ parent | string | 必须 | |||
| ├─ authorityGroups | object | 非必须 | 用户角色集合 | ||
| ├─ appKey | string | 必须 | 应用key | ||
| ├─ authorityGroupKey | string | 必须 | 角色key | ||
| ├─ authorityGroupName | string | 必须 | 角色名称 | ||
| ├─ authorityGroupParent | string | 非必须 | 父角色Key | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ authorityEntities | object | 非必须 | 该角色绑定的工功能列表 | ||
| ├─ appKey | string | 必须 | 应用key | ||
| ├─ authorityKey | string | 必须 | 功能Key | ||
| ├─ name | string | 必须 | 功能名称 | ||
| ├─ description | string | 非必须 | 功能描述 | ||
| ├─ parent | string | 非必须 | 父功能 | ||
| ├─ children | object | 非必须 | 子角色 | ||
| ├─ appKey | string | 必须 | |||
| ├─ authorityGroupKey | string | 必须 | |||
| ├─ authorityGroupName | string | 必须 | |||
| ├─ authorityGroupParent | string | 非必须 | |||
| ├─ description | string | 非必须 | |||
| ├─ authorityEntities | object | 非必须 | |||
| ├─ children | object | 非必须 |
我关联的应用列表
基本信息
Path： /user2/listMyRelateApps
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ appKey | string | 必须 | 应用key | ||
| ├─ name | string | 必须 | 应用名称 | ||
| ├─ description | string | 非必须 | 应用描述 | ||
| ├─ status | boolean | 必须 | 应用状态 | ||
| ├─ createdDate | string | 必须 | 应用创建时间 |
当前用户是否应用开发者【Feign】
基本信息
Path： /user2/isAppDeveloper
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | String类型，应用Key |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| boolean | 非必须 |
当前用户是否有权限访问应用【Feign】
基本信息
Path： /user2/checkUserRelateApp
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| appKey | 是 | 应用Key | |
| userUid | 否 | userUid不为空校验指定用户是否有权访问指定应用，含开发者判断 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| boolean | 非必须 |
