提供一组与用户相关的服务接口,云端应用通过本组服务可以实现用户的解绑,获取用户绑定的设备列表信息等。

分页查询用户列表

定义描述

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

请求参数

参数 类型 必填 描述
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":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "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"
    }
    					

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

定义描述

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

请求参数

参数 类型 必填 描述
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":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "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.4 获取用户绑定的设备列表(包括设备详情)详情内容 不支持设备数量超过100
/cloud/device/queryByUser 1.0.5 获取用户绑定的设备列表(包括设备详情)详情内容 通过偏移量的方式支持设备数量无限制

请求参数

参数 类型 必填 描述
openId String 三方用户外标(openId和identityId二者必须有其一)
openIdAppKey String 平台颁发给三方应用的appKey
identityId String 用户身份id(openId和identityId二者必须有其一)
limit int 1.0.5新增参数,获取个数限制
offset int 1.0.5新增参数,偏移量

返回参数

参数 类型 描述
identityId String 用户的身份ID
iotId String 设备的iotId
productKey String 设备的productKey
deviceName String 设备的deviceName
productName String 设备的产品名称
categoryImage String 设备的产品图片
productModel String 设备的产品型号
nickName String 用户对设备的昵称
netType String 设备入网类型lora:NET_LORAgprs:NET_CELLULARwifi:NET_WIFIzigbee:NET_ZIGBEE蓝牙:NET_BT以太网:NET_ETHERNET其他:NET_OTHER
thingType String 设备的类型:VIRTUAL,VIRTUAL_SHADOW,WEB,APP,DEVICE
status Byte 设备的状态0:未激活 1:在线 3:离线 8:禁用
说明 1.0.5版本不支持该字段
owned int 分享标记
  • 0:普通用户(分享者)
  • 1:管理员(拥有者)

示例

  • 请求示例一
    • 传入openId和openIdAppKey
      {
         "id":"55428a70-a740-4b54-bd7f-89f727744740",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "params": {
            "openId":"10000000001",
            "openIdAppKey":"xxx"
          },
          "version": "1.0"
      }
      							
    • 传入identityId
      {
         "id":"55428a70-a740-4b54-bd7f-89f727744740",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "params": {
            "identityId": "506bop1ef3a1ce8005d731e0df57ae175ac94618"
          },
          "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"
    }
    					
  • 请求示例二
    • 传入openId和openIdAppKey
      {
         "id":"55428a70-a740-4b54-bd7f-89f727744740",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.5"
          },
          "params": {
            "openId":"10000000001",
            "openIdAppKey":"xxx",
            "limit":50,
            "offset":100
          },
          "version": "1.0"
      }
      							
    • 传入identityId
      {
         "id":"55428a70-a740-4b54-bd7f-89f727744740",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "params": {
            "identityId": "506bop1ef3a1ce8005d731e0df57ae175ac94618",
            "limit":50,
            "offset":100
          },
          "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-复制"
          }],
          "message": "success"
      },
      "id": "55428a70-a740-4b54-bd7f-89f727744740"
    }
    					

解绑用户和设备

定义描述

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

请求参数

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

返回参数

示例

  • 请求示例
    • 传入openId和openIdAppKey
      {
         "id":"3389580f-c698-4a83-9eee-b576c6d6c874",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "params": {
            "openId":"10000000001",
            "openIdAppKey":"xxx"
          },
          "version": "1.0"
      }
      							
    • 传入identityId
      {
         "id":"3389580f-c698-4a83-9eee-b576c6d6c874",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "params": {
            "identityId": "506bop1ef3a1ce8005d731e0df57ae175ac94618"
          },
          "version": "1.0"
      }
      							
  • 正常返回示例
    {
      "code": 200,
      "data": "",
      "id": "3389580f-c698-4a83-9eee-b576c6d6c874"
    }
    					

根据身份id获取第三方openid

定义描述

Path 版本 描述 是否需要用户身份的鉴权
/cloud/account/openId/getByIdentityId 1.0.4 根据身份ID获取第三方OAuth OpenId
说明 当且仅当使用第三方账号体系时,使用该API接口。

请求参数

参数 类型 是否必填 描述
identityId String 身份id
openIdAppKey String 开放平台颁发的appKey

返回参数

参数 类型 是否必填 描述
openId String 账号身份id

示例

  • 请求示例
    {
       "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5",
          "request": {
            "apiVer": "1.0.4"
          },
          "params": {
            "request": {
          "identityId":"506bop1ef3a1ce8005d731e0df57ae175ac94618",
          "openIdAppKey":"12345678"
          }
          },
          "version": "1.0"
    }
  • 正常返回示例
    {
        "code": 200,
        "data": "506bop1ef3a1ce8005d731e0df57ae175ac94618",
        "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
    }

根据设备查找所有绑定的用户

定义描述

path 版本 描述 是否需要用户身份的鉴权
/living/user/device/binding/query 1.0.0 根据设备iotid查询绑定账户

请求参数

参数 类型 必填 描述
iotId String 设备ID
pageNo Integer 分页页数,从1开始
pageSize Integer 分页大小

返回参数

名称 类型 必有 描述
total Integer 总记录条数
accountDevDTOList 绑定列表 待确认 绑定列表
[].identityId 待确认 待确认 绑定人身份ID
[].owned 待确认 待确认
  • 0:分享者
  • 1:拥有者

示例

  • 请求示例
    {
         "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.0"
          },
          "params": {
            "iotId":"VPuHLddp6fisYryXdk0T0010dbd910",
            "pageNo": 1,
            "pageSize": 50
          },
          "version": "1.0"
    }
    					
  • 正常返回示例
    {
        "code": 200,
        "data": [
            {
                "identityId":506bop1ef3a1ce8005d731e0df57ae175ac94618,
                "owned":0
            }
        ],
        "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
    }
    					

通过identityid查询账户的详细信息

定义描述

path 版本 描述 是否需要用户身份的鉴权
/cloud/account/getByIdentityId 1.0.4 通过IdentityId查询账户的详细信息(IdentityId可以通过/cloud/account/queryIdentityByPage接口获得),无内容值的字段不返回

请求参数

参数 类型 必填 描述
identityId String 身份id列表

返回参数

名称 类型 描述
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":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "params": {
            "identityId":"506bop1ef3a1ce8005d731e0df57ae175ac94618"
          },
          "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 版本 描述 是否需要用户身份的鉴权
/user/account/info/update 1.0.0 -

请求参数

参数 类型 必填 描述
openIdAppKey String 飞燕颁发OpenId AppKey
openId String 自有账号系统的openIUd
identityId String 否(openId/identityId 须至少填写一项) 飞燕身份id
nickName String 昵称

返回参数

示例

  • 请求示例
    {
         "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5",
          "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.0.4"
          },
          "params": {
            "identityId":"506bop1ef3a1ce8005d731e0df57ae175ac94618",
            "nickName":"飞燕用户001"
          },
          "version": "1.0"
    }
  • 正常返回示例
    {
        "code": 200,
        "data": {},
        "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
    }