API 中心

数字工厂底座

地市云

获取当前用户[租户端用户]的子帐号列表-openAPI

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

本页目录：

接口描述

注意

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

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

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeSubAccounts

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

接口是否需要携带Token：是

输入参数

字段 类型 说明
Limit Query 返回条数限制
Offset Query 返回页数限制
SearchKey Query 根据昵称/联系邮箱/手机号查询用户信息

输出参数

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

SubAccounts

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

Account

字段名 字段类型 字段描述
NickName String 昵称，用户名
Type Integer 账号类型，1:主账户 2:子账户
Role Integer 用户角色，0:普通用户 1:CP服务商 10:SP运营商 20:客户经理
Status Integer 账号状态
AccountId Long 账号ID
MasterId Long 主账户ID
AccountName String 账户名，主账户登录邮箱, 子账户的创建名
ContactMail String 联系邮箱
ContactMobile String 联系手机

示例

输出示例

{
    "SubAccounts": {
        "Total": 2,
        "RequestId": "379ak9lrlnnqa1tj9rkvbgiq286up-4n",
        "Accounts": [{
            "AccountId": "1",
            "AccountName": "18842647883@163.com",
            "RegisterType": 0,
            "Type": 2,
            "Role": 10,
            "NickName": "小王",
            "MasterId": 10001,
            "Status": 2,
            "ContactMail": "18842647883@163.com",
            "ContactMobile": "183xxx1942"
        }]
    }
}

错误码

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

错误码 描述