用户上下文信息

简述:

  • 用户申请授权码

请求URL:

请求方式:

  • 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:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • 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:

请求方式:

  • POST

请求参数:

  • Headers:

暂无

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

暂无

请求参数示例:

{
  "access_token":"61797200f9fa11e906ee9dff8b7b5da8"
}

返回示例:

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

返回参数说明:

名称 类型 备注
data Void null

用户解锁

简述:

  • 用户解锁

请求URL:

请求方式:

  • POST

请求参数:

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

暂无

  • Body:

暂无

请求参数示例:

暂无

返回示例:

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

返回参数说明:

名称 类型 备注
data Void null

是否注册模式

简述:

  • 是否注册模式

请求URL:

请求方式:

  • GET

请求参数:

  • 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:

请求方式:

  • GET

请求参数:

  • Headers:

暂无

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

暂无

请求参数示例:

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

返回示例:

待完善

返回参数说明:

名称 类型 备注
data Object 待完善

修改密码

简述:

  • 修改密码

请求URL:

请求方式:

  • 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:

请求方式:

  • POST

请求参数:

  • Headers:

暂无

  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
fullName String 姓名
gender String 性别
mobile String 手机号码
passWd String 密码
company String 公司名称
area String 区域
dataChk String 校验码
validCode String 验证码

请求参数示例:

待完善

返回示例:

待完善

返回参数说明:

名称 类型 备注
data Object 待完善

重置密码-用户注册使用

简述:

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

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:

暂无

  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
fullName String 姓名
gender String 性别
mobile String 手机号码
passWd String 密码
company String 公司名称
area String 区域
dataChk String 校验码
validCode String 验证码

请求参数示例:

暂无

返回示例:

暂无

返回参数说明:

名称 类型 备注
data Object 待完善

发送验证码

简述:

  • 传入注册对象,发送验证码

请求URL:

请求方式:

  • GET

请求参数:

  • 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 待完善

备注

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

文档更新时间: 2019-11-20 16:36   作者:Eddy