文档首页/ 硬件开发工具链平台云服务/ API参考/ IPDCenter基础服务API/ 用户组织管理API/ 用户接口/ 查询用户团队及角色信息
更新时间：2024-07-24 GMT+08:00
查看PDF
分享

查询用户团队及角色信息

功能介绍

查询用户团队及角色信息。

URI

POST /unidata/public/api/v1/xdm-user/list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

JWTToken
表2 请求Body参数

参数

是否必选

参数类型

描述

limit

否

Integer

分页大小，每页显示的条目数量

最小值：1

缺省值：10

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0

最小值：0

最大值：50000

缺省值：0

user_id

否

String

用户id

username

否

String

用户名

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

String

异常编码

message

String

异常信息

total_count

String

数据总条数

datas

Array of UserData objects

用户数据
表4 UserData

参数

参数类型

描述

user_id

String

用户id

username

String

用户名称

effect_time

String

生效时间

expire_time

String

失效时间

teams

Array of TeamData objects

团队信息

roles

Array of TeamRoleData objects

角色信息
表5 TeamData

参数

参数类型

描述

name

String

团队名称

description

String

团队描述

team_id

String

团队id

name_en

String

团队英文名称

description_en

String

团队英文描述
表6 TeamRoleData

参数

参数类型

描述

name

String

团队角色名称

description

String

团队角色描述

team_id

String

团队角色id

name_en

String

团队角色英文名称

description_en

String

团队角色英文描述

状态码： 400

表7 响应Body参数

参数

参数类型

描述

reserve

String

保留字段

error_code

String

错误编码

error_msg

String

错误信息

请求示例

{{host}}/unidata/public/api/v1/xdm-user/list

{
  "user_id" : "",
  "username" : "",
  "offset" : 0,
  "limit" : 10
}

响应示例

状态码： 200

成功

{
  "code" : "IPDC.01040000",
  "message" : "success",
  "datas" : [ {
    "user_id" : "1008600000065107508",
    "username" : "hid_o1qtefcd_uhw64u",
    "effect_time" : "2024-02-22 18:04:01.090754",
    "expire_time" : "2099-12-31 23:59:59",
    "teams" : [ {
      "id" : 625000742695997400,
      "name" : "IPDCenter基础服务团队1_副本1",
      "description" : "111111",
      "name_en" : "IPDCenter base1_copy1",
      "description_en" : "111111"
    } ],
    "roles" : [ {
      "id" : 621367206130757600,
      "name" : "want",
      "description" : "",
      "name_en" : "wang",
      "description_en" : ""
    } ]
  } ],
  "total_count" : 1
}

状态码： 400

认证失败

{
  "reserve" : null,
  "error_code" : "AUTH-600001",
  "error_msg" : ""
}

状态码

状态码

描述

200

成功

400

认证失败

500

服务器内部异常

错误码

请参见错误码。

父主题： 用户接口

相关文档