API 中心

数字工厂底座

地市云

获取当前用户[运营端用户]的子用户列表-openAPI

最近更新时间：9/29/2021, 8:16:00 PM作者：andrewren(任豪)

本页目录：

接口描述

注意

以下接口仅在【v5.9】版本后支持

接口请求域名：http[s]://iam-app-api.{工业环境域名}

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeSPSubAccounts

本接口用于获取运营端用户的子账号列表。

接口是否需要携带Token：是

输入参数

参数名称 必选 类型 描述
Limit 是 Integer 返回条数限制
Offset 是 Integer 返回页数限制
SearchKey 是 String 根据昵称/联系邮箱/手机号查询用户信息

输出参数

参数名称 类型 描述
SubAccounts SubAccounts 子账号信息

SubAccounts

参数名称 类型 描述
Accounts Array Of Account 账号信息
Total Integer 总数
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId

Account

参数名称 类型 描述
AccountId String 账号ID
AccountName String 账号名
RegisterType Integer 注册类型
Type Integer 账号类型
Role Integer 角色
NickName String 昵称
MasterId String 主账号ID
Status Integer 状态
ContactMail String 联系邮箱
ContactMobile String 联系手机

示例

输出示例

{
    "SubAccounts": {
        "Total": 2,
        "RequestId": "yxa7v8t5krmnpgstcsr2p64u9i2luyfm",
        "Accounts": [{
            "AccountId": "1",
            "AccountName": "18842647883@163.com",
            "RegisterType": 0,
            "Type": 2,
            "Role": 10,
            "NickName": "小王",
            "MasterId": 10001,
            "Status": 2,
            "ContactMail": "18842647883@163.com",
            "ContactMobile": "18310071942"
        }]
    }
}

错误码

以下仅列出了接口业务逻辑相关的错误码

错误码 描述