账号服务
更新时间:2018-06-25 11:35:00
提供一组与用户账号体系相关的服务接口,通过本组服务接口可以实现用户账户信息的查询和设置。
查询统一身份列表
定义描述
path |
版本 |
描述 |
是否需要用户身份的鉴权 |
/iotx/account/queryIdentityList |
1.0.4 |
查询统一身份列表 |
否 |
请求参数
名称 |
子键 |
类型 |
必填 |
描述 |
request |
|
JSON |
是 |
JSON对象 |
|
identityIds |
List |
是 |
账号身份id列表 |
返回参数
名称 |
类型 |
必有 |
描述 |
identityId |
String |
|
账号身份id |
loginId |
String |
|
OA loginId |
loginSource |
String |
|
账号来源,目前为openAccount |
loginName |
String |
|
登录名 |
phone |
String |
|
手机号 |
email |
String |
|
邮箱 |
nickName |
String |
|
昵称 |
avatarUrl |
String |
|
头像链接 |
gmtCreate |
Long |
|
创建时间 |
gmtModified |
Long |
|
修改时间 |
示例
请求示例
{
"id":1508232047194,
"request": {
"apiVer": "1.0.4"
},
"params": {
"request": {"identityIds":["506bop1ef3a1ce8005d731e0df57ae175ac94618"]}
},
"version": "1.0"
}
正常返回示例
{
"code": 200,
"data": [
{
"gmtModified": 1508314232000,
"loginId": "4398047084811",
"gmtCreate": 1508314232000,
"identityId": "506bop1ef3a1ce8005d731e0df57ae175ac94618",
"loginSource": "openAccount",
}
],
"id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}
错误码
错误码 |
错误信息 |
来源 |
描述 |
200 |
success |
系统 |
成功 |
400 |
request error. |
系统 |
请求错误 |
401 |
request auth error. |
系统 |
请求认证错误 |
403 |
request forbidden. |
系统 |
请求被禁止 |
404 |
service not found. |
系统 |
服务未找到 |
429 |
too many requests. |
系统 |
太多请求 |
460 |
request parameter error. |
系统 |
请求参数错误 |
500 |
service error. |
系统 |
服务端错误 |
503 |
service not available. |
系统 |
服务不可用 |
修改账号属性
定义描述
path |
版本 |
描述 |
是否需要用户身份的鉴权 |
/iotx/account/modifyAccount |
1.0.4 |
修改账号属性 |
是,客户端SDK需启用身份的鉴权 |
请求参数
名称 |
子键 |
类型 |
必填 |
描述 |
|
request |
|
JSON |
是 |
JSON对象 |
|
|
iotToken |
String |
是 |
iotToken |
|
|
accountMetaV2 |
JSON |
是 |
JSON对象 |
|
|
|
子键 |
类型 |
必填 |
描述 |
|
|
loginName |
String |
否 |
登录名 |
|
|
phone |
|
手机号和邮箱至少一个必填 |
手机号 |
|
|
email |
String |
手机号和邮箱至少一个必填 |
邮箱 |
|
|
nickName |
String |
否 |
昵称 |
|
|
password |
String |
否 |
密码 |
|
|
appKey |
String |
是 |
OA 的appKey |
|
|
creater |
String |
否 |
创建者 |
|
|
modifier |
String |
否 |
修改者 |
|
|
avatarUrl |
String |
否 |
头像链接 |
返回参数
示例
请求示例
{
"id":1508232047194,
"request": {
"iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
"apiVer": "1.0.4"
},
"params": {
"request": {"identityId":"50e5opda16ebf5558e000a660ac9632a038c2479", "accountMetaV2":{"phone":"15757286621", "appKey":"60039075","nickName":"test"}}
},
"version": "1.0"
}
正常返回示例
{"code":200,"data":"","id":"a2845614-7156-42ff-94f7-9bc8db03bfa1"}
错误码
错误码 |
错误信息 |
来源 |
描述 |
200 |
success |
系统 |
成功 |
400 |
request error. |
系统 |
请求错误 |
401 |
request auth error. |
系统 |
请求认证错误 |
403 |
request forbidden. |
系统 |
请求被禁止 |
404 |
service not found. |
系统 |
服务未找到 |
429 |
too many requests. |
系统 |
太多请求 |
460 |
request parameter error. |
系统 |
请求参数错误 |
500 |
service error. |
系统 |
服务端错误 |
503 |
service not available. |
系统 |
服务不可用 |