用户服务

更新时间：2018-09-10 20:07:40

分页查询用户列表

定义描述

path 版本 描述 是否需要cloudToken
/cloud/account/queryIdentityByPage 1.0.0 分页查询租户下的用户列表是 是

请求参数

参数 类型 必填 描述
offset Integer 否 查询偏移量
count Integer 否 分页查询数量

返回参数

名称 类型 描述
identityId String 账号的身份ID
loginId String 登陆ID
loginSource String 账号来源
gmtCreate Long 创建时间
gmtModified Long 修改时间
loginName String 登陆名
phone String 手机号
email String 邮箱
nickName String 昵称
avatarUrl String 头像
gender String 性别
lastLoginTime Date 上次登录时间
onlineStatus Integer 账号登录态是否在线，1-在线；0-离线

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.0"
      },
      "params": {
        "offset":0, "count":1
      },
      "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "data": [
        {
            "gmtModified": 1508314232000,
            "loginId": "4398047084811",
            "gmtCreate": 1508314232000,
            "identityId": "506bop1ef3a1ce8005d731e0df57ae175ac94618",
            "loginSource": "openAccount",
            "loginName":"test",
            "phone":"13888888888",
            "email":"test@aliyun.com",
            "nickName":"test"
        }
    ],
    "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}

错误码

错误码 错误信息 描述
460 invalid count or offset! 无效的count或offset，count必须大于0， offset大于等于0

通过三方外标查询账号信息

定义描述

path 版本 描述 是否需要cloudToken
/cloud/account/getByOpenId 1.0.0 通过三方外标查询账号信息 是

请求参数

参数 类型 必填 描述
openId String 是 自有账号外标
openIdAppKey String 是 应用的appKey

返回参数

名称 类型 描述
identityId String 账号的身份ID
loginId String 账号的openAccountId
loginSource String 账号来源
gmtCreate Long 创建时间
gmtModified Long 修改时间
loginName String 登陆名
phone String 手机号
email String 邮箱
nickName String 昵称
tenantId String 租户ID
gender String 性别
lastLoginTime Long 上次登陆时间
avatarUrl String 头像
onlineStatus Integer 账号登录态是否在线，1-在线；0-离线

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.0"
      },
      "params": {
        "openId":"4398050099996", "openIdAppKey":"appkey1"
      },
      "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "data": [
        {
            "gmtModified":1515590332000,
            "loginId":"4398050099996",
            "gmtCreate":1513181985000,
            "lastLoginTime":1515590332000,
            "phone":"15757245467",
            "identityId":"5091op618500614829ee12fae93ba653a5928119",
            "loginName":"15757245467",
            "tenantId":"45CFEA759A994F48A8305D59452B1437",
            "loginSource":"openAccount"
            "email":"test@aliyun.com",
            "nickName":"test"
        }
    ],
    "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}

错误码

错误码 错误信息 描述

获取用户绑定的设备列表（包括设备详情）详情内容

定义描述

path 版本 描述 是否需要cloudToken
/cloud/device/queryByUser 1.0.0 获取用户绑定的设备列表（包括设备详情）详情内容 是

请求参数

参数 类型 必填 描述
openId String 是 三方用户外标
openIdAppKey String 是 平台颁发的appKey

返回参数

参数
类型
描述
identityId
String
用户的身份ID
iotId
String
设备的iotId
productKey
String
设备的productKey
deviceName
String
设备的deviceName
productName
String
设备的产品名称
categoryImage
String
设备的产品图片
productModel
String
设备的产品型号
nickName
String
用户对设备的昵称
netType
String
设备入网类型
lora: NET_LORA
gprs: NET_CELLULAR
wifi: NET_WIFI
zigbee: NET_ZIGBEE
蓝牙: NET_BT
以太网: NET_ETHERNET
其他: NET_OTHER
thingType
String
设备的类型:"VIRTUAL", "WEB", "APP","DEVICE"
status
Byte
设备的状态
0：未激活 1：在线 3：离线 8：禁用
owned
int
分享标记
1: 管理员（拥有者）
2: 普通用户（被分享者）

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.0"
      },
      "params": {
        "openId":"10000000001",
        "openIdAppKey":"xxx"
      },
      "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "data": {
        "code": 200,
        "data": [{
            "iotId": "VPuHLddp6fisYryXdk0T0010dbd910",
            "identityId": "50ceop3441838d879e23f01933ab455be61f0356",
            "netType": "NET_WIFI",
            "thingType": "DEVICE",
            "productKey": "a1FNS8TYhpQ",
            "deviceName": "VD_sdDaqyTXeQ",
            "productName": "风扇3-复制",
            "status": 3
        }],
        "message": "success"
    },
    "id": "55428a70-a740-4b54-bd7f-89f727744740"
}

错误码

错误码 错误信息 描述
28514 tenant not match 租户不匹配

解绑用户和设备

定义描述

path 版本 描述 是否需要cloudToken
/cloud/user/device/unbind 1.0.0 解绑用户和设备 是

请求参数

参数 类型 必填 描述
openId String 是 三方用户外标id
openIdAppKey String 是 开放平台颁发的appKey
iotId String 是 iotId

返回参数

参数 类型 描述

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.0"
      },
      "params": {
        "offset":0, "count":1
      },
      "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "data": "",
    "id": "3389580f-c698-4a83-9eee-b576c6d6c874"
}

错误码

错误码 错误信息 描述
28514 tenant not match 租户不匹配

results matching ""

    No results matching ""