获取终端用户列表
更新时间：2024-01-26
获取终端用户列表
接口描述
本接口用于获取终端用户列表，并且返回每个终端用户已分配的desktopId。
请求结构
JSON
1GET /v1/bvd/enduser/list{?desktopId,endUserIds,endUserName,marker,maxKeys}
2Host: bec.baidubce.com
3Authorization: authorization string
4X-Bce-Accesskey: accesskey请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| marker | 标记查询的起始位置 | query | false | string |
| maxKeys | 每页包含的最大数量，1-1000，默认1000 | query | false | integer |
| desktopId | 按已分配的桌面ID过滤 | query | false | string |
| endUserIds | 按终端用户ID列表过滤 | query | false | string数组 |
| endUserName | 按终端用户Name查询 | query | false | string |
响应头域
除公共头域外，无其它特殊头域。
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
响应参数
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| isTruncated | true表示后面还有数据，false表示已经是最后一页 | boolean | |
| marker | 标记查询的起始位置 | string | |
| maxKeys | 每页包含的最大数量 | integer | |
| nextMarker | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 | string | |
| result | 终端用户列表 | array | EndUserVo |
| authorized | 是/否(true/false)已分配给指定桌面 | boolean | |
| description | 描述 | string | |
| desktopIds | 已分配的桌面ID | array | string |
| 邮箱 | string | ||
| endUserId | 终端用户ID | string | |
| mobilePhone | 手机号 | string | |
| name | 终端用户登录名 | string | |
| status | 状态：active 启用 inactive 禁用 | string | |
| createTime | 创建时间 | string | |
| totalCount | 总数 | integer |
错误码
请参照错误返回章节的内容。
请求示例
JSON
1GET /v1/bvd/enduser/list HTTP/1.1
2Host: bec.baidubce.com
3Authorization: 响应示例
JSON
1200 OK
2
3{
4 "isTruncated": false,
5 "maxKeys": 1000,
6 "totalCount": 1,
7 "result": [
8 {
9 "endUserId": "xxxxx",
10 "name": "user1",
11 "email": "",
12 "mobilePhone": "*******6429",
13 "description": "用户1",
14 "status": "active",
15 "organizationId": "yyyyy",
16 "organizationName": "myorg",
17 "createTime": "2023-05-04T10:08:22Z",
18 "authorized": false
19 }
20 ]
21}