文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 用户组/ 查询用户组中的用户
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

查询用户组中的用户

功能介绍

该接口用于查询用户组中的用户。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/groups/{group_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。

group_id

是

String

用户组ID。
表2 Query参数

参数

是否必选

参数类型

描述

user_name

否

String

用户名支持模糊查询。

description

否

String

用户描述支持模糊查询。

active_type

否

String

激活类型。

  • USER_ACTIVATE：用户激活

  • ADMIN_ACTIVATE：管理员激活

limit

否

String

用于分页查询，返回桌面数量限制。如果不指定或为0，默认2000，最大2000。

offset

否

String

用于分页查询，查询的起始记录序号，从0开始。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

发送的实体的MIME类型，如：application/json。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

users

Array of UserInGroup objects

组关联的用户列表。

total_count

Integer

用户列表中用户总数。
表5 UserInGroup

参数

参数类型

描述

id

String

用户ID。

user_name

String

桌面用户名。

user_email

String

用户邮箱。

user_phone

String

用户手机号。

total_desktops

Integer

用户桌面数。

description

String

用户描述。

请求示例

无

响应示例

状态码： 200

组关联的用户列表响应。

{
  "total_count" : 2,
  "users" : [ {
    "user_name" : "user1",
    "user_email" : "xx1@mail.com",
    "user_phone" : "18818008887",
    "id" : "8357fd328c62447d94e452bf49xxxx"
  }, {
    "user_name" : "user2",
    "user_email" : "xx2@mail.com",
    "user_phone" : "18818008888",
    "id" : "8357fd328c62447d94e452bf495xxxx"
  } ]
}

状态码

状态码

描述

200

组关联的用户列表响应。

错误码

请参见错误码。

父主题： 用户组

相关文档