# 查询用户列表 - ListUsers #### 功能介绍 该接口用于查询桌面用户列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListUsers)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:users:list | List | user \* | - | - | - | | workspace:users:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/users 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_name | 否 | String | 桌面用户名，长度范围为1-20，不能包含特殊字符，不能以数字开头。 | | user_names | 否 | Array of strings | 桌面用户名列表。 | | limit | 否 | String | 用于分页查询，返回用户数量限制。如果不指定，则返回所有符合条件的用户。 | | offset | 否 | String | 分页查询起始条数。 | | description | 否 | String | 用户描述查询，模糊匹配。 | | active_type | 否 | String | 激活类型，默认为用户激活。 - USER_ACTIVATE： 用户激活 - ADMIN_ACTIVATE： 管理员激活 | | group_name | 否 | String | 桌面用户组名，精确匹配。 | | share_space_subscription | 否 | Boolean | 用户是否已订阅协同，true/false。 | | share_space_desktops | 否 | Boolean | 用户是否已绑定协同桌面,true/false。 | | is_query_total_desktops | 否 | Boolean | 是否查询用户绑定的桌面数,true/false,默认true。 | | enterprise_project_id | 否 | String | 企业项目ID。 | | disabled | 否 | Boolean | 用户是否被禁用 | | domain | 否 | String | 域。 | | platform_type | 否 | String | 用户类型。 - AD： AD域用户 - LOCAL： 本地liteAs用户 - UOS： UOS域用户 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | 用户总数。 | | users | Array of [User] objects | 用户列表。 | 表4User | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 用户ID。 | | sid | String | 用户ID。 | | user_name | String | 桌面用户名。 | | user_email | String | 用户邮箱。 | | total_desktops | Integer | 用户绑定桌面云总数。 | | user_phone | String | 手机号。 | | active_type | String | 激活类型，默认为用户激活。 - USER_ACTIVATE： 用户激活 - ADMIN_ACTIVATE： 管理员激活 | | is_pre_user | Boolean | 是不是预创建的用户。 | | account_expires | String | 账户过期时间，0表示永远不过期。 | | password_never_expired | Boolean | 密码是否永不过期，true表示密码永不过期，false表示密码会过期。 | | account_expired | Boolean | 账号是否过期，true表示已过期，false表示未过期。 | | enable_change_password | Boolean | 是否允许修改密码，true表示允许，false表示不允许。 | | next_login_change_password | Boolean | 下次登录是否需要重置密码，true表示需要重置密码，false表示不需要。 | | description | String | 用户描述。 | | locked | Boolean | 账户是否被锁定，true表示被锁定，false表示未锁定。 | | disabled | Boolean | 账户是否禁用，true表示被禁用，false表示未禁用。 | | share_space_subscription | Boolean | 用户是否订阅协同，true表示已订阅，false表示未订阅。 | | share_space_desktops | Integer | 用户已绑定协同桌面数。 | | group_names | Array of strings | 加入的组列表。 | | enterprise_project_id | String | 企业项目ID。 | | user_info_map | String | 用户信息映射，包含用户的服务等级、操作模式和类型。 | | domain | String | 域。 | | certificate_status | Boolean | 当前用户是否存在用户证书。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：405** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：503** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users?limit=10 ``` #### 响应示例 **状态码：200** 查询桌面云用户列表响应。 ``` { "total_count" : 2, "users" : [ { "id" : "8a2c3f9579d240820179d51e6caf0001", "user_name" : "api-test", "user_email" : "test@huawei.com", "total_desktops" : 0, "account_expires" : "0", "enable_change_password" : true, "next_login_change_password" : true, "locked" : false, "disabled" : false }, { "id" : "8a2c3f9579d240820179d51e6caf0002", "user_name" : "api-test2", "user_email" : "test@huawei.com", "total_desktops" : 0, "account_expires" : "0", "enable_change_password" : true, "next_login_change_password" : true, "locked" : false, "disabled" : false } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询桌面云用户列表响应。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 405 | 请求中指定的方法不被允许。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | | 503 | 服务不可用。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。