按用户属性筛选查询便捷账号信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:FilterUsers |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| MaxResults |
integer |
否 |
分页查询时每页行数（大于 100 时会自动重置为 100）。 |
10 |
| NextToken |
string |
否 |
下一次查询的 Token。首次调用接口时无需设置该参数。如果一次查询结果并没有完整返回所有的结果，则返回的 NextToken 不为空。您可以在查询中上传返回的 NextToken 继续查询。 |
caeba0bbb2be03f84eb48b699f0a**** |
| Filter |
string |
否 |
模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（*），例如将该字段设为 a*m，则返回用户名或邮箱以 a 开头、以 m 结尾的所有结果。 |
a*m |
| PropertyFilterParam |
array<object> |
否 |
要模糊查询的用户属性列表。 |
|
|
object |
否 |
要模糊查询的用户属性。 |
||
| PropertyId |
integer |
否 |
属性 ID。 |
328 |
| PropertyValueIds |
string |
否 |
属性值 ID。 |
1255 |
| PropertyKeyValueFilterParam |
array<object> |
否 |
属性名和属性值信息列表。 |
|
|
object |
否 |
属性名和属性值信息。 |
||
| PropertyKey |
string |
否 |
属性名。 |
job |
| PropertyValues |
string |
否 |
属性值。 |
dev |
| IncludeDesktopCount |
boolean |
否 |
是否返回已分配给该用户的云电脑数量。 枚举值：
|
true |
| IncludeDesktopGroupCount |
boolean |
否 |
是否返回已分配给该用户的云电脑池数量。 枚举值：
|
false |
| OrgId |
string |
否 |
企业组织 ID。 |
org-aliyun-wy-org-id |
| OwnerType |
string |
否 |
账号激活类型。 枚举值：
|
Normal |
| IncludeEndUserIds |
array |
否 |
||
|
string |
否 |
|||
| ExcludeEndUserIds |
array |
否 |
需精确排除的用户名（EndUserId）列表。 |
|
|
string |
否 |
按用户名（EndUserId）精确排除，查询不包含该用户名的用户列表。 |
tony |
|
| OrderParam |
object |
否 |
支持的排序参数。 |
|
| OrderField |
string |
否 |
按此参数排序。 枚举值：
|
id |
| OrderType |
string |
否 |
升序或降序。 枚举值：
|
DESC |
| Status |
integer |
否 |
筛选用户状态。 枚举值：
|
0 |
| IsQueryAllSubOrgs |
boolean |
否 |
是否查询所有子组织 |
|
| IncludeOrgInfo |
boolean |
否 |
是否包含组织信息 |
|
| IncludeSupportIdps |
boolean |
否 |
包含支持的登录类型 |
|
| BusinessChannel |
string |
否 |
渠道 |
ENTERPRISE |
| FilterMap |
object |
否 |
||
|
string |
否 |
|||
| ShowExtras |
object |
否 |
||
|
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息集合。 |
||
| RequestId |
string |
请求 ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| NextToken |
string |
下一次查询的 Token。如果一次查询结果并没有完整返回所有的结果，则返回的 NextToken 不为空。您可以在查询中上传返回的 NextToken 继续查询。 |
caeba0bbb2be03f84eb48b699f0a**** |
| Users |
array<object> |
便捷账号信息集合。 |
|
|
array<object> |
便捷账号信息。 |
||
| Id |
integer |
用户 ID。 |
4205** |
| EndUserId |
string |
用户名。 |
alice |
|
string |
邮箱。 |
username@example.com |
|
| Phone |
string |
手机号。 |
1381111**** |
| Status |
integer |
便捷账号的状态。 枚举值：
|
0 |
| UserSetPropertiesModels |
array<object> |
用户属性集合。 |
|
|
array<object> |
用户属性。 |
||
| UserId |
integer |
绑定属性的用户 ID。 |
4205** |
| UserName |
string |
绑定属性的用户名。 |
alice |
| PropertyId |
integer |
用户属性 ID。 |
12 |
| PropertyKey |
string |
用户属性名称。 |
department |
| PropertyType |
integer |
用户属性编号。 |
2 |
| PropertyValues |
array<object> |
用户属性值。 |
|
|
object |
用户属性值。 |
||
| PropertyValueId |
integer |
用户属性值 ID。 |
42 |
| PropertyValue |
string |
用户属性值。 |
dev |
| DesktopCount |
integer |
分配给该用户的云电脑数量。 |
1 |
| ExternalInfo |
object |
用户扩展信息。 |
|
| ExternalName |
string |
用户对接的账号名称。 |
account |
| JobNumber |
string |
用户对接的账号、学号或工号。 |
030801 |
| DesktopGroupCount |
integer |
用户拥有授权的云电脑池数量。当 |
2 |
| OwnerType |
string |
账号归属类型。 枚举值：
|
Normal |
| Remark |
string |
用户备注。 |
测试专用 |
| IsTenantManager |
boolean |
是否租户管理员。 枚举值：
|
true |
| EnableAdminAccess |
boolean |
是否本地管理员。 枚举值：
|
true |
| RealNickName |
string |
用户昵称。 |
小明 |
| AutoLockTime |
string |
自动锁定账号的日期，格式为 YYYY-MM-DD。 |
2023-03-03 |
| PasswordExpireDays |
integer |
用户账号的密码默认为永久有效，可通过此参数设置 30~365 天的密码有效期，当密码到期后，终端用户必须先修改密码才能继续登录。 说明
该功能目前处于邀测中，如需体验，请提交工单申请开通。 |
30 |
| PasswordExpireRestDays |
integer |
账号密码有效期的剩余天数。 |
10 |
| OrgList |
array<object> |
用户所属组织列表 |
|
|
object |
用户所属组织列表 |
||
| OrgId |
string |
组织结构 ID |
|
| OrgName |
string |
组织结构名称 |
|
| OrgNamePath |
string |
组织结构名称路径 |
|
| SupportLoginIdps |
array<object> |
支持的登录身份源方式 |
|
|
object |
支持的登录身份源方式 |
||
| IdpId |
string |
企业身份源 ID |
|
| IdpName |
string |
企业身份源名称 |
|
| Groups |
array<object> |
||
|
object |
|||
| GroupId |
string |
||
| GroupName |
string |
||
| ResourcePolicyList |
array<object> |
||
|
object |
|||
| PolicyId |
string |
||
| PolicyName |
string |
示例
正常返回示例
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"Users": [
{
"Id": 0,
"EndUserId": "alice",
"Email": "username@example.com",
"Phone": "1381111****",
"Status": 0,
"UserSetPropertiesModels": [
{
"UserId": 0,
"UserName": "alice",
"PropertyId": 12,
"PropertyKey": "department",
"PropertyType": 2,
"PropertyValues": [
{
"PropertyValueId": 42,
"PropertyValue": "dev"
}
]
}
],
"DesktopCount": 1,
"ExternalInfo": {
"ExternalName": "account",
"JobNumber": "030801"
},
"DesktopGroupCount": 2,
"OwnerType": "Normal",
"Remark": "测试专用",
"IsTenantManager": true,
"EnableAdminAccess": true,
"RealNickName": "小明",
"AutoLockTime": "2023-03-03",
"PasswordExpireDays": 30,
"PasswordExpireRestDays": 10,
"OrgList": [
{
"OrgId": "",
"OrgName": "",
"OrgNamePath": ""
}
],
"SupportLoginIdps": [
{
"IdpId": "",
"IdpName": ""
}
],
"Groups": [
{
"GroupId": "",
"GroupName": ""
}
],
"ResourcePolicyList": [
{
"PolicyId": "",
"PolicyName": ""
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。