账号服务

更新时间：2019-05-27 21:31:47

提供一组与用户账号体系相关的服务接口，通过本组服务接口可以实现用户账户信息的查询和设置。

查询统一身份列表

定义描述

path 版本 描述 是否需要用户身份的鉴权
/iotx/account/queryIdentityList 1.0.4 查询统一身份列表 否

请求参数

参数 类型 必填 描述
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"
}

错误码

请参考公共错误码

修改账号属性

定义描述

path 版本 描述 是否需要用户身份的鉴权
/iotx/account/modifyAccount 1.0.5 修改账号属性 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
identityId String 是 identityId
accountMetaV2 JSON 是 账户属性信息

accountMetaV2结构

参数 类型 必填 描述
loginName String 否 登录名
phone String 手机号和邮箱至少一个必填 手机号
email String 手机号和邮箱至少一个必填 邮箱
nickName String 否 昵称
appKey String 是 OA 的appKey
avatarUrl String 否 头像链接

返回参数

名称 类型 必有 描述

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.5"
      },
      "params": {
        "request": {"identityId":"50e5opda16ebf5558e000a660ac9632a038c2479", "accountMetaV2":{"phone":"15757286621", "appKey":"60039075","nickName":"test"}}
      },
      "version": "1.0"
}

正常返回示例

{
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}

错误码

请参考公共错误码

账号注销

定义描述

path 版本 描述 是否需要用户身份的鉴权
account/unregister 1.0.6 账号注销 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述

返回参数

名称 类型 必有 描述

示例

请求示例

{
     "id":1508232047196,
      "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.6"
      },
      "params": {
       },
      "version": "1.0"
}

正常返回示例

{
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}

错误码

请参考公共错误码

检测账号是否已注册

定义描述

path 版本 描述 是否需要用户身份的鉴权
/user/account/regcheck 1.0.0 检测账号是否已注册 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
phone String 否 手机号
email String 否 邮箱地址

返回参数

名称 类型 必有 描述
data Bool 是 是否已经注册（true表示已经注册，false表示未注册)

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
        "request": {
          "phone": "18601234567",
          "email": "xxxx@xxx.com"
        }
      },
      "version": "1.0"
}

正常返回示例

{
  "id": "8d1a665e-ce92-45bf-add8-99d2e81814f3",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": false
}

错误码

请参考公共错误码

查询统一身份

定义描述

path 版本 描述 是否需要用户身份的鉴权
/user/account/identity/query 1.0.0 查询统一身份 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
loginId String 否 OA loginId
loginSource String 否 账号来源类型（OA）
phone String 否 手机号
email String 否 邮箱地址
opType Int 是 1-根据loginId & loginSouce；2-根据手机号码；3-根据邮箱;其他非法

返回参数

名称 类型 必有 描述
phone String 手机号
identityId String 统一身份Id
nickName String 用户昵称
loginId String OA loginId
avatarUrl String 头像地址
loginName String 登录名
loginSource String 账号来源

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
        "request": {
          "loginId": "value1",
          "loginSource": "value2",
          "phone": "value3",
          "email": "value4",
          "opType": "value5",
        }
      },
      "version": "1.0"
}

正常返回示例

{
  "id": "8d1a665e-ce92-45bf-add8-99d2e81814f3",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": {
    "identityId": "5053opf5d4a333333324473f5db0e73982",
    "loginId": "493265",
    "loginSource": "openAccount",
    "modifier": "system",
    "nickName": "ktt",
    "phone": "138333333662",
    "loginName": "tester"
  }
}

错误码

请参考公共错误码

根据登录态获取当前用户的详细信息

定义描述

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 手机号
email String 邮箱地址

示例

请求示例

{
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.1"
      },
      "params": {
        "request": {
          "iotToken": "xxxxxxxxxxxxx",
        }
      },
      "version": "1.0"
}

正常返回示例

{
  "id": "8d1a665e-ce92-45bf-add8-99d2e81814f3",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": {
    "companyId": "95BDDAEEF0E34test8240A19D5",
    "companyName": "test物联技术有限公司",
    "identityId": "5022al4d34b6c5test0a542af3fac06085",
    "loginName": "test物联",
    "nickName": "test物联",
    "phone": "xxxxxxxxxxx",
    "email": "abc@cc.com"
  }
}

错误码

请参考公共错误码

results matching ""

    No results matching ""