提供一组与用户账号体系相关的服务接口,通过本组服务接口可以实现用户账户信息的查询和设置。
注销账号
定义描述
path | 版本 | 描述 | 是否需要用户身份的鉴权 |
path | 版本 | 描述 | 是否需要用户身份的鉴权 |
account/unregister | 1.0.6 | 账号注销 | 是,客户端SDK需启用身份的鉴权,进行身份认证 |
请求参数
无业务请求参数
返回参数
无业务返回参数
示例
请求示例
{ "id":1508232047196, "request": { "iotToken": "109049cxxxxxxxxb15f6f62e29a3ba", "apiVer": "1.0.6" }, "params": { }, "version": "1.0" }
正常返回示例
{ "code": 200, "message": "success", "localizedMsg": null, "class": "com.aliyun.iotx.common.base.service.IoTxResult" }
根据登录态获取当前用户的详细信息
定义描述
path | 版本 | 描述 | 是否需要用户身份的鉴权 |
path | 版本 | 描述 | 是否需要用户身份的鉴权 |
/user/account/session/authidentity | 1.0.1 | 根据登录态获取当前用户的详细信息 | 是,客户端SDK需启用身份的鉴权,进行身份认证 |
请求参数
参数 | 类型 | 必填 | 描述 |
参数 | 类型 | 必填 | 描述 |
iotToken | String | 是 | 用户登录态 |
返回参数
名称 | 类型 | 描述 |
名称 | 类型 | 描述 |
companyId | String | 公司ID |
companyName | String | 公司名 |
identityId | String | 统一身份ID |
loginName | String | 登录名 |
nickName | String | 昵称 |
phone | String | 手机号 |
String | 邮箱地址 |
示例
请求示例
{ "id":1508232047194, "request": { "apiVer": "1.0.1" }, "params": { "request": { "iotToken": "xxxxxxxxxxxxx", } }, "version": "1.0" }
正常返回示例
{ "id": "8d1a665e-ce92-xxxx-xxxx-99d2e81814f3", "code": 200, "message": null, "localizedMsg": null, "data": { "companyId": "95BDDAxxxxxxxxt8240A19D5", "companyName": "test物联技术有限公司", "identityId": "5022al4d34xxxxxxxxaf3fac06085", "loginName": "test物联", "nickName": "test物联", "phone": "xxxxxxxxxxx", "email": "a***@example.net" } }
获取用户上传头像的URL及加密签名
当用户需要修改头像时流程如下。
调用此接口获取上传的URL和签名等参数。
App取得上传的URL和签名等参数后,通过POST方法将头像上传(请参见PostObject)。
上传时header中的x-oss-forbid-overwrite参数不能设置为true,否则可能导致上传失败。上传成功后,根据流程1中调用接口的返回参数中的host、dir拼接得出头像图片URL地址(拼接规则为
“https://”+ host + “/” + dir
)。通过修改账号属性接口更新图像URL。
path | 版本 | 描述 | 是否需要用户身份的鉴权 |
path | 版本 | 描述 | 是否需要用户身份的鉴权 |
/living/user/avatar/upload/signature/get | 1.0.0 | 用户头像上传URL以及加密签名获取 | 是,客户端SDK需启用身份的鉴权,进行身份认证 |
请求参数
参数 | 类型 | 必填 | 描述 |
参数 | 类型 | 必填 | 描述 |
fileSize | int | 是 | 头像图片文件大小,单位为字节,取值范围最小为1;最大为10485760(10M)。 |
返回参数
名称 | 类型 | 描述 |
名称 | 类型 | 描述 |
accessKey | String | OSS的accessKey |
dir | String | 图片在OSS桶里的存储目录 |
expire | Long | 过期时间戳,毫秒为单位,在此时间戳之前可以向OSS上传头像 |
host | String | OSS访问域名地址 |
signature | String | 签名 |
policy | String | 请求表单域的合法性校验信息 |
示例
请求示例
{ "id":1508232047194, "request": { "apiVer": "1.0.0" }, "params": { "request": { "fileSize": 300888 } }, "version": "1.0" }
正常返回示例
{ "id":1508232047194, "code":200, "data": { "signature":"b45CXXXXXXXXXXXXXXXXXXXXXX", "accessKey":"LTAXXXXXXXXXXXXX", "expire":1578077777777, "host":"xxxx.oss-ap-shanghai.aliyuncs.com", "dir":"images/third_app_user/profile/50adopbXXXXXX_MmI2NGJjZD.png", "policy":"eyJleHBpcmFXXXXXXXXXXX0aW9uIjoiMjAy" } }
- 本页导读 (0)
- 注销账号
- 根据登录态获取当前用户的详细信息
- 获取用户上传头像的URL及加密签名