工业数据应用平台如何进行账号管理_工业互联网平台(IIoT)-阿里云帮助中心

账号数据开放接口。

1.查询角色列表接口

使用接口查询出角色信息, 支持分页, 条件查询

路径	/industry/asset/openapi/role/list
版本	1.0.0

请求参数

名称

类型

是否必填

示例值

描述

请求示例

响应参数

名称	类型	示例值	描述
id	String	fc101fec	响应id
code	Int	200	响应码200：成功
message	String		错误消息
localizedMsg	String		本地语言错误消息
data	JSON		角色集合
roleName	String	管理员	角色名
roleDesc	String	这是管理员	角色描述
roleCode	String	v7bc0d9245	角色编号

响应示例

{
    "id":"4de2c367-c1db-417c-aa15-8c585******",
    "code":200,
    "data":[
        {
            "roleCode":"40bc37bc0d9245bfa73db3dd36******",
            "roleName":"系统管理员",
            "roleDesc":"this系统管理员"
        },
        {
            "roleCode":"40bc37bc0d9245bfa73db3dd36******",
            "roleName":"操作员",
            "roleDesc":"this操作员"
        }
    ]
}

2.新增用户接口

新增加用户账号, 其中loginName（登录账号）是唯一的且不允许变更

路径	/industry/asset/openapi/user/add
版本	1.0.0

请求参数

名称	类型	是否必填	示例值	描述
loginName	String	是	algx	登录账号, 唯一且不可变更
nickName	String	是	张三	姓名
roleCodes	JSON	是	cb20d2ca47	所属角色编号集合
phone	String	否	188********	手机
email	String	否	a@*.com	邮箱

请求示例

{
    "nickName":"张",
    "roleCodes":[
        "cb20d2ca477d453ab7ff752f21******",
        "40bc37bc0d9245bfa73db3dd36******"
    ],
    "phone":"13800******",
    "email":"username@example.com",
    "loginName":"zhangsan******"
}

响应参数

名称	类型	示例值	描述
id	String		响应id
code	Int	200	响应码200：成功
message	String		错误消息
localizedMsg	String		本地语言错误消息
data	JSON
auid	String	10	用户ID

响应示例

{
    "code":200,
    "data":{
        "auid":"284966467a914362b5***************"
    },
    "id":"13800******"
}

3.查询用户列表接口

使用接口查询出用户信息, 支持分页, 条件查询

路径	/industry/asset/openapi/user/list
版本	1.0.0

请求参数

名称	类型	是否必填	示例值	描述
pageNo	Int	否	10	页号，默认为1
pageSize	Int	否	50	每页数量，默认为0
keyWord	String	否	管理员	关键词搜索（按姓名/手机/登录账号）

请求示例

{
  "pageNo":1,
  "pageSize":20,
  "keyWord":"管理员"
}

响应参数

名称	类型	示例值	描述
id	String		响应id
code	int	200	响应码200：成功
message	String		错误消息
localizedMsg	String		本地语言错误消息
data	JSON
total	Int	10	总数量
list	JSON		用户集合
- auid	String	503eal0ef1db4*****	用户ID
- loginName	String	Alice	登录账号
- nickName	String	张先生	姓名
- phone	String	13800*******	手机号
- email	String	username@example.com	邮箱
- roleList	JSON		角色集合
- - roleCode	String	efcbd2d****	角色编号
- - roleName	String	管理员	角色名
- orgList	JSON		组织集合
- - organizationId	String	efcbd2d****	组织ID
- - organizationName	String	昆山基地	组织名

响应示例

{
    "code":200,
    "data":{
        "total":2,
        "list":[
            {
                "auid":"284966467a914362b5*********",
                "nickName":"张先生",
                "phone":"13800*******",
                "loginName":"Alex",
                "email":"username@example.com",
                "roleList":[
                    {
                        "roleCode":"ADMINISTRATOR",
                        "roleName":"系统管理员"
                    }
                ],
                "organizationList":[
                    {
                        "organizationId":"566f4ac574da46e291ca405*******",
                        "organizationName":"业务人员1",
                        "order":1
                    }
                ]
            },
            {
                "auid":"284966467a914362b53313db*******",
                "nickName":"张先生",
                "phone":"13800******",
                "loginName":"Alex",
                "email":"username@example.com",
                "roleList":[
                    {
                        "roleCode":"ADMINISTRATOR",
                        "roleName":"系统管理员"
                    }
                ],
                "organizationList":[
                    {
                        "organizationId":"566f4ac574da46e291ca405********",
                        "organizationName":"业务人员1",
                        "order":1
                    }
                ]
            }
        ]
    },
    "id":"16238484*****"
}

4.修改用户接口

根据登录账号修改用户信息.

路径	/industry/asset/openapi/user/update
版本	1.0.0

请求参数

名称	类型	是否必填	示例值	描述
loginName	String	是	alex	登录账号, 唯一且不可变更
nickName	String	是	张先生	姓名
roleCodes	JSON	是		所属角色集合
phone	String	否	13800******	手机
email	String	否	username@example.com	邮箱

请求示例

{
    "nickName":"张先生",
    "roleCodes":[
        "cb20d2ca477d453ab7ff752f21******",
        "40bc37bc0d9245bfa73db3dd3******"
    ],
    "phone":"13800******",
    "email":"username@example.com",
    "loginName":"alex"
}

响应参数

名称	类型	示例值	描述
id	String		响应id
code	Int	200	响应码200：成功
message	String		错误消息
localizedMsg	String		本地语言错误消息
data			无返回

响应示例

{
    "code":200,
    "data":null,
    "id":"162384844xxxx"
}

5.删除用户接口

删除用户账号

路径	/industry/asset/openapi/user/delete
版本	1.0.0

请求参数

名称	类型	是否必填	示例值	描述
loginNameList	JSON	是		登录账号集合

请求示例

{
    "loginNameList":["alex","alex1"]
}

响应参数

名称	类型	示例值	描述
id	String		响应id
code	Int	200	响应码200：成功
message	String		错误消息
localizedMsg	String		本地语言错误消息
data			无返回

响应示例

{
    "code":200,
    "data":null,
    "id":"162384844****"
}