提供一组与用户相关的服务接口,云端应用通过本组服务可以实现用户的解绑,获取用户绑定的设备列表信息等。
分页查询用户列表
定义描述
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 | 手机号 |
String | 邮箱 | |
nickName | String | 昵称 |
avatarUrl | String | 头像 |
gender | String | 性别 |
lastLoginTime | Date | 上次登录时间 |
onlineStatus | Integer | 账号登录态是否在线
|
示例
- 请求示例
{ "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5", "request": { "cloudToken": "109049c8xxxxxxxxf62e29a3ba", "apiVer": "1.0.4" }, "params": { "offset":0, "count":1 }, "version": "1.0" }
- 正常返回示例
{ "code": 200, "data": [ { "gmtModified": 1508314232000, "loginId": "4398047084811", "gmtCreate": 1508314232000, "identityId": "506bop1ef3axxxxxxxx7ae175ac94618", "loginSource": "openAccount", "loginName":"test", "phone":"1381111****", "email":"test@aliyun.com", "nickName":"test" } ], "id":"bb179e80-39fd-xxxx-xxxx-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 | 手机号 |
String | 邮箱 | |
nickName | String | 昵称 |
tenantId | String | 租户ID |
gender | String | 性别 |
lastLoginTime | Long | 上次登录时间 |
avatarUrl | String | 头像 |
onlineStatus | Integer | 账号登录态是否在线
|
示例
- 请求示例
{ "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5", "request": { "cloudToken": "109049c8xxxxxxxx6f62e29a3ba", "apiVer": "1.0.4" }, "params": { "openId":"4398050099996", "openIdAppKey":"appkey1" }, "version": "1.0" }
- 正常返回示例
{ "code": 200, "data": { "gmtModified":1515590332000, "loginId":"4398050099996", "gmtCreate":1513181985000, "lastLoginTime":1515590332000, "phone":"1390000****", "identityId":"5091op618xxxxxxxxe93ba653a5928119", "loginName":"1390000****", "tenantId":"45CFEA7xxxxxxxx05D59452B1437", "loginSource":"openAccount" "email":"test@aliyun.com", "nickName":"test" } , "message":"success" }
获取用户绑定的设备列表(包括设备详情)
定义描述
path | 版本 | 描述 | 是否需要cloudToken | 说明 |
---|---|---|---|---|
/cloud/device/queryByUser | 1.0.6 | 获取用户绑定的设备列表(包括设备详情)详情内容 | 是 | 查询用户绑定的设备列表;通过设置不同的偏移量来查询任意部分的记录,暂不提供总条数查询 |
请求参数
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
openId | String | 否 | 三方用户外标(openId和identityId二者必须有其一) |
openIdAppKey | String | 否 | 平台颁发给三方应用的appKey |
identityId | String | 否 | 用户身份id(openId和identityId二者必须有其一) |
limit | int | 否 | 1.0.5新增参数,获取个数限制,limit取值不能超过100 |
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 | 设备入网类型:
|
thingType | String | 物的类型:
|
status | Byte | 设备的状态,0:未激活 1:在线 3:离线 8:禁用
说明 1.0.6版本之前不支持该字段。
|
owned | int | 分享标记
|
示例
- 请求示例
- 传入openId和openIdAppKey
{ "id":"55428a70-a740-4xxxx-xxxx-89f727744740", "request": { "cloudToken": "109049cxxxxxxxx6f62e29a3ba", "apiVer": "1.0.6" }, "params": { "openId":"10000000001", "openIdAppKey":"xxx", "limit":50, "offset":100 }, "version": "1.0" }
- 传入identityId
{ "id":"55428a70-a740-xxxx-xxxx-89f727744740", "request": { "cloudToken": "109049c8xxxxxxxx6f62e29a3ba", "apiVer": "1.0.6" }, "params": { "identityId": "506bop1efxxxxxxxx57ae175ac94618", "limit":50, "offset":100 }, "version": "1.0" }
- 传入openId和openIdAppKey
- 正常返回示例
{ "code": 200, "data": { "code": 200, "data": [{ "iotId": "VPuHLddp6fixxxxxxxx10dbd910", "identityId": "50ceop3441838xxxxxxxx455be61f0356", "netType": "NET_WIFI", "thingType": "DEVICE", "productKey": "a1FNS8TYhpQ", "deviceName": "VD_sdDaqyTXeQ", "productName": "风扇3-复制" }], "message": "success" }, "id": "55428a70-a740-xxxx-xxxx-89f727744740" }
解绑用户和设备
定义描述
path | 版本 | 描述 | 是否需要cloudToken |
---|---|---|---|
/cloud/user/device/unbind | 1.0.4 | 解绑用户和设备 | 是 |
请求参数
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
openId | String | 否 | 三方用户外标id(openId和identityId二者必须有其一) |
openIdAppKey | String | 否 | 开放平台颁发的appKey(如果使用openId,则该参数为必需) |
identityId | String | 否 | 用户身份id(openId和identityId二者必须有其一) |
iotId | String | 是 | iotId |
返回参数
无
示例
- 请求示例
- 传入openId和openIdAppKey
{ "id":"3389580f-c698-xxxx-xxxx-b576c6d6c874", "request": { "cloudToken": "109049c80xxxxxxxx6f62e29a3ba", "apiVer": "1.0.4" }, "params": { "openId":"10000000001", "openIdAppKey":"xxx" "iotId":"VPuHLddpxxxxxxxx0010dbd910" }, "version": "1.0" }
- 传入identityId
{ "id":"3389580f-c698-xxxx-xxxx-b576c6d6c874", "request": { "cloudToken": "109049c8xxxxxxxxf62e29a3ba", "apiVer": "1.0.4" }, "params": { "identityId": "506bop1ef3a1xxxxxxxx7ae175ac94618" "iotId":"VPuHLddp6xxxxxxxx010dbd910" }, "version": "1.0" }
- 传入openId和openIdAppKey
- 正常返回示例
{ "code": 200, "data": "", "id": "3389580f-c698-xxxx-xxxx-b576c6d6c874" }
强制解除设备上所有绑定关系
定义描述
path | 版本 | 描述 | 是否需要cloudToken |
---|---|---|---|
/living/cloud/user/binding/device/unbind | 1.0.0 | 提供解除指定设备上所有绑定关系的能力 | 是 |
请求参数
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
iotId | String | 否 | 设备唯一标志ID;当productKey和deviceName为空时,该入参不能为空。 |
productKey | String | 否 | 设备的productKey,当iotId为空时,该参数不能为空。 |
deviceName | String | 否 | 设备的deviceName,当iotId为空时,该参数不能为空。 |
返回参数
无业务返回参数
示例
- 请求示例
{ "id":"3389580f-c698-4a83-9eee-b576c6d6c874", "request": { "cloudToken": "109049c80bxxxxx06b15f6f62e29a3ba", "apiVer": "1.0.0" }, "params": { "iotId":"Aawfy6tNxxxxxKOJ9Ffg000101" }, "version": "1.0" }
- 正常返回示例
{ "code": 200, "data": "", "id": "3389580f-c698-4a83-9eee-b576c6d6c874" }
根据身份ID获取第三方openid
定义描述
Path | 版本 | 描述 | 是否需要cloudToken |
---|---|---|---|
/cloud/account/openId/getByIdentityId | 1.0.4 | 根据身份ID获取第三方OAuth OpenId | 是 |
说明 当且仅当使用第三方账号体系时,使用该API接口。
请求参数
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
identityId | String | 是 | 身份id |
openIdAppKey | String | 是 | 开放平台颁发的appKey |
返回参数
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
data | String | 是 | 账号身份id |
示例
- 请求示例
{ "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5", "request":{ "apiVer":"1.0.4" }, "params":{ "identityId":"506bop1ef3xxxxxxxxf57ae175ac94618", "openIdAppKey":"12345678" }, "version":"1.0" }
- 正常返回示例
{ "code": 200, "data": "506bop1ef3a1cexxxxxxxx175ac94618", "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5" }
根据设备查找所有绑定的用户
定义描述
path | 版本 | 描述 | 是否需要cloudToken |
---|---|---|---|
/living/user/device/binding/query | 1.0.0 | 根据设备iotid查询绑定账户 | 是 |
请求参数
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
iotId | String | 是 | 设备ID |
pageNo | Integer | 是 | 分页页数,从1开始 |
pageSize | Integer | 是 | 分页大小 |
返回参数
参数 | 子参数 | 二级子参数 | 类型 | 描述 |
---|---|---|---|---|
data | JSON | 绑定用户列表 | ||
total | Integer | 总记录条数 | ||
accountDevList | jsonArray | 绑定列表 | ||
deviceName | String | 设备的deviceName | ||
identityId | String | 用户账号id | ||
iotId | String | 设备的iotId | ||
nickName | String | 用户对设备设置的昵称,可为空 | ||
owned | Integer |
|
||
productKey | Date | 设备的productKey | ||
productName | String | 设备的产品名称 |
示例
- 请求示例
{ "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5", "request": { "cloudToken": "109049c80bxxxxxxxx62e29a3ba", "apiVer": "1.0.0" }, "params": { "iotId":"VPuHLddpxxxxxxxx0010dbd910", "pageNo": 1, "pageSize": 50 }, "version": "1.0" }
- 正常返回示例
{ "code": 200, "data": { "accountDevList":[ { "deviceName":"00158D00xxxxB3", "identityId":"50caop1fxxxxxxxxe55dae27b479165", "iotId":"OK61KXgxxxxxxxxtTk000100", "nickName":"红外过道2", "owned":1, "productKey":"a1xxxxyZ", "productName":"红外探测器", } ], "total":1 }, "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5" }
通过identityid查询账户的详细信息
定义描述
path | 版本 | 描述 | 是否需要cloudToken |
---|---|---|---|
/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 | 手机号 |
String | 邮箱 | |
nickName | String | 昵称 |
avatarUrl | String | 头像 |
gender | String | 性别 |
lastLoginTime | Date | 上次登录时间 |
onlineStatus | Integer | 账号登录态是否在线
|
示例
- 请求示例
{ "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5", "request": { "cloudToken": "109049c8xxxxxxxxf6f62e29a3ba", "apiVer": "1.0.4" }, "params": { "identityId":"506bop1ef3xxxxxxxx57ae175ac94618" }, "version": "1.0" }
- 正常返回示例
{ "code": 200, "data": { "gmtModified":1515590332000, "loginId":"4398050099996", "gmtCreate":1513181985000, "lastLoginTime":1515590332000, "phone":"1390000****", "identityId":"5091op61850061xxxxxxxxba653a5928119", "loginName":"1390000****", "tenantId":"45CFEA75xxxxxxxxD59452B1437", "loginSource":"openAccount" "email":"test@aliyun.com", "nickName":"test" }, "message":"success" }
更新自有账号系统在平台内的用户昵称
定义描述
path | 版本 | 描述 | 是否需要cloudToken |
---|---|---|---|
/user/account/info/update | 1.0.0 | - | 是 |
请求参数
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
openIdAppKey | String | 是 | 平台颁发的OpenId AppKey |
openId | String | 否 | 自有账号系统的openId |
identityId | String | 否(openId/identityId须至少填写一项) | 用户账号id |
nickName | String | 是 | 用户账号昵称 |
返回参数
无
示例
- 请求示例
{ "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5", "request": { "cloudToken": "109049c8xxxxxxxxf6f62e29a3ba", "apiVer": "1.0.4" }, "params": { "identityId":"506bop1ef3a1xxxxxxxxf57ae175ac94618", "nickName":"飞燕用户001" }, "version": "1.0" }
- 正常返回示例
{ "code": 200, "data": {}, "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5" }