文档

暂无数据！

阅读次数：169

用户接口文档

用户上下文信息
用户上下文信息
登陆
登出
用户解锁
是否注册模式
获取注册信息
修改密码
注册
重置密码-用户注册使用
发送验证码
企业微信登陆
获取验证码开启状态
获取验证码
第三方平台获取用户的信息
备注

作者：Eddy 历史版本：1 更新时间：2024-07-05 12:05

用户上下文信息

简述：

用户上下文信息

请求URL：

http://ip:port/ibps/oauth2/v3/user/context
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
username	String	是		用户账号

Body：

暂无

请求参数示例：

{
  "username":"admin"
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "role": [],
        "org": {
            "pk": "",
            "name": "广州流辰信息",
            "ip": null,
            "createBy": null,
            "createTime": "2019-09-23 14:09:54",
            "updateBy": null,
            "updateTime": "2019-10-19 17:40:30",
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "625695342267990016",
            "partyType": null,
            "parentId": null,
            "path": null,
            "depth": null,
            "sn": null,
            "levelID": "466946461976756224",
            "roleIDs": "",
            "orgAlias": "gzlcxx",
            "status": "actived",
            "level": null,
            "pathName": null,
            "hasChild": false
        },
        "tenantId": null,
        "positions": null,
        "employee": {
            "pk": "",
            "name": "zjh",
            "ip": null,
            "createBy": null,
            "createTime": "2019-09-25 09:46:35",
            "updateBy": null,
            "updateTime": "2019-09-25 09:47:20",
            "tenantId": "0",
            "dataStatus": null,
            "dbtype": null,
            "id": "626353848415420416",
            "partyType": null,
            "alias": null,
            "parentId": null,
            "path": null,
            "depth": null,
            "sn": null,
            "profile": null,
            "status": "actived",
            "gender": "male",
            "email": "zjh20140614@163.com",
            "address": null,
            "mobile": "",
            "qq": null,
            "photo": "/file/getImage?attachmentId=626353894800228352",
            "positions": null,
            "groupID": "625695342267990016",
            "wcAccount": null,
            "account": "zjh",
            "isSuper": "Y",
            "orgName": "广州流辰信息",
            "isMainPost": null,
            "isPrincipal": null,
            "pinYinHeadChar": "zjh",
            "source": null
        },
        "user": {
            "pk": "",
            "name": "zjh",
            "ip": null,
            "createBy": null,
            "createTime": "2019-09-25 09:46:35",
            "updateBy": null,
            "updateTime": "2019-09-25 09:47:20",
            "tenantId": null,
            "dataStatus": null,
            "dbtype": null,
            "id": "626353848415420416",
            "account": "zjh",
            "password": null,
            "isSuper": "Y",
            "dataCheck": null,
            "wcAccount": null,
            "fullname": "zjh",
            "status": "actived",
            "gender": "male",
            "mobile": "",
            "email": "zjh20140614@163.com",
            "address": null,
            "qq": null,
            "photo": "/file/getImage?attachmentId=626353894800228352",
            "userId": "626353848415420416",
            "super": true
        },
        "mainPosition": null,
        "tenantIds": null
    }
}

返回参数说明：

名称	类型	备注
data	Map	用户相关信息

Map包含内容：

名称	类型	备注
role	Array	角色信息
org	Object	归属组织信息
user	Object	用户信息
employee	Object	员工信息
tenantId	String	租户ID
tenantIds	String	租户ID集合字符串，逗号分隔
mainPosition	Object	主岗位信息
positions	Array	岗位集合信息

用户上下文信息

简述：

用户上下文信息

请求URL：

http://ip:port/ibps/oauth2/v3/user/context/default
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

暂无

Query：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		访问令牌
tenantId	String	否		租户ID

Body：

暂无

请求参数示例：

{
  "X-Authorization-access_token":"aaaa"
}

返回示例：

结果同/oauth2/v3/user/context接口

返回参数说明：

名称	类型	备注
data	Map	用户相关信息

Map包含内容：

名称	类型	备注
role	Array	角色信息
org	Object	归属组织信息
user	Object	用户信息
employee	Object	员工信息
tenantId	String	租户ID
tenantIds	String	租户ID集合字符串，逗号分隔
mainPosition	Object	主岗位信息
positions	Array	岗位集合信息

登陆

简述：

登陆，传入用户名密码

请求URL：

http://ip:port/ibps/oauth2/v3/user/login/apply
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

暂无

Query：

暂无

Body：

名称	类型	是否必须	备注
username	String	是	用户账号
password	String	是	用户密码
captcha	String	否	验证码
requestId	String	否	请求ID

请求参数示例：

{
    "username": "zjh",
    "password": "123456",
    "captcha": "",
    "requestId": ""
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": "616e7580f9fa11e906ee9dff8b7b5da8"
}

返回参数说明：

名称	类型	备注
data	String	登录状态

登出

简述：

登出系统，传入令牌

请求URL：

http://ip:port/ibps/oauth2/v3/user/logout
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

暂无

Query：

名称	类型	是否必须	默认值	备注	其他信息
access_token	String	是		系统令牌

Body：

暂无

请求参数示例：

{
  "access_token":"61797200f9fa11e906ee9dff8b7b5da8"
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void	null

用户解锁

简述：

用户解锁

请求URL：

http://ip:port/ibps/oauth2/v3/user/unlock
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

暂无

请求参数示例：

暂无

返回示例：

{
  "state": 200,
  "request": null,
  "message": "",
  "cause": "",
  "variables": {},
  "data": null
}

返回参数说明：

名称	类型	备注
data	Void	null

是否注册模式

简述：

是否注册模式

请求URL：

http://ip:port/ibps/oauth2/v3/user/open
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

暂无

Query：

暂无

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/oauth2/v3/user/open

返回示例：

{
  "state": 200,
  "request": null,
  "message": "",
  "cause": "",
  "variables": {},
  "data": false
}

返回参数说明：

名称	类型	备注
data	Boolean	是否开启注册

获取注册信息

简述：

获取注册信息

请求URL：

http://ip:port/ibps/oauth2/v3/user/register/get
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

暂无

Query：

名称	类型	是否必须	默认值	备注	其他信息
mobile	String	是		手机号码

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/oauth2/v3/user/register/get?mobile=13588888888

返回示例：

待完善

返回参数说明：

名称	类型	备注
data	Object	待完善

修改密码

简述：

修改密码

请求URL：

http://ip:port/ibps/oauth2/v3/user/register/change/passwd
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

暂无

Query：

暂无

Body：

名称	类型	是否必须	备注
userIds	List< String>	是	用户id数组
primitivePassword	String	否	原始密码
newPassword	String	否	新密码
repeatPassword	String	否	重复新密码
reset	String	否	是否重置，0-非重置、1-重置、2-还原默认密码’123456’

请求参数示例：

示例1：

{
    "userIds": ["626353848415420416"],
    "newPassword": "123",
    "repeatPassword": "123",
    "primitivePassword": "1",
    "reset": 0
}

示例2：

{
    "userIds": ["626353848415420416"],
    "reset": 2
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void	null

注册

简述：

传入注册对象,注册账号

请求URL：

http://ip:port/ibps/oauth2/v3/user/register
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

暂无

Query：

暂无

Body：

名称	类型	是否必须	备注
fullName	String	是	姓名
gender	String	是	性别
mobile	String	是	手机号码
passWd	String	是	密码
company	String	是	公司名称
area	String	是	区域
dataChk	String	否	校验码
validCode	String	是	验证码

请求参数示例：

待完善

返回示例：

待完善

返回参数说明：

名称	类型	备注
data	Object	待完善

重置密码-用户注册使用

简述：

传入注册对象，重置密码-用户注册使用

请求URL：

http://ip:port/ibps/oauth2/v3/user/reset/passwd
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

暂无

Query：

暂无

Body：

名称	类型	是否必须	备注
fullName	String	否	姓名
gender	String	否	性别
mobile	String	是	手机号码
passWd	String	是	密码
company	String	否	公司名称
area	String	否	区域
dataChk	String	否	校验码
validCode	String	是	验证码

请求参数示例：

暂无

返回示例：

暂无

返回参数说明：

名称	类型	备注
data	Object	待完善

发送验证码

简述：

传入注册对象，发送验证码

请求URL：

http://ip:port/ibps/oauth2/v3/user/send/sms
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

暂无

Query：

名称	类型	是否必须	默认值	备注	其他信息
mobile	String	是		手机号码
forget	Boolean	是		是否重置密码

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/oauth2/v3/user/send/sms?forget=false&mobile=13588888888

返回示例：

待完善

返回参数说明：

名称	类型	备注
data	Object	待完善

企业微信登陆

简述：

企业微信登陆

请求URL：

http://ip:port/ibps/oauth2/v3/user/login/wechat/apply
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

暂无

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
code	String	是		微信随机code,企业微信发起链接带的参数

请求参数示例：

{
    "code": "abc"
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": "616e7580f9fa11e906ee9dff8b7b5da8"
}

返回参数说明：

名称	类型	备注
data	String	登录状态

获取验证码开启状态

简述：

获取验证码开启状态

请求URL：

http://ip:port/ibps/oauth2/v3/captcha/open
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

暂无

Query：

名称	类型	是否必须	默认值	备注	其他信息
requestId	String	否		请求ID

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/oauth2/v3/captcha/open

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": false
}

返回参数说明：

名称	类型	备注
data	Boolean	是否开启验证码

获取验证码

简述：

获取验证码

请求URL：

http://ip:port/ibps/oauth2/v3/user/captcha
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

暂无

Query：

名称	类型	是否必须	默认值	备注	其他信息
requestId	String	否		请求ID

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/oauth2/v3/user/captcha

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {
        "requestId": "90f7b8e206fc4934bc62dfd9b919a0b5"
    },
    "data": "data:image/png;base64,iVBORw0KGgoA..."
}

返回参数说明：

名称	类型	备注
data	String	待完善

第三方平台获取用户的信息

概述：

获取令牌和凭证后，可获取用户的信息。

简述：

获取用户信息

请求URL：

http://ip:port/ibps/oauth2/v3/user/getUserInfo
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

暂无

Query：

名称	类型	是否必须	默认值	备注	其他信息
code	String	是		凭证	第三方获得令牌时获取的参数

Body：

暂无

请求参数示例：

http://ip:port/ibps/oauth2/v3/user/getUserInfo?code=086670360d004dd78b681d602e50741d

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "gender": "male",
        "mobile": null,
        "name": "张三",
        "tenantId": "123",
        "account": "zhangsan",
        "email": "123@163.com"
    }
}

返回参数说明：

名称	类型	备注	其他信息
state	int	状态码	状态码
request	String	请求路径
message	String	响应消息
cause	String	异常信息
variables	String	响应变量
data	String	用户信息
gender	String	性别
mobile	String	电话号码
name	String	姓名
tenantId	String	租户ID
account	String	IBPS账号
email	String	邮箱

备注

返回格式详情请移步全局格式-响应格式