FilterUsers - Cloud Phone - Alibaba Cloud Documentation Center

Filters convenience accounts by property.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:FilterUsers	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	long	No	The number of entries per page. If you set this parameter to a value greater than 100, the system resets the value to 100.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. If not all results are returned in a query, a value is returned for the NextToken parameter. In this case, you can use the returned NextToken value to start the next query.	caeba0bbb2be03f84eb48b699f0a4883
Filter	string	No	The string that is used for fuzzy search. You can use usernames and email addresses to perform fuzzy search. Wildcard characters () are supported for this parameter. For example, if you set this parameter to am, the usernames or an email addresses that start with a or end with m are returned.	test
PropertyFilterParam	array<object>	No	The list of properties for fuzzy search.
	object	No	The custom parameter that is configured by the user.
PropertyId	long	No	The ID of the property.	123
PropertyValueIds	string	No	The IDs of the property values.	test
PropertyKeyValueFilterParam	array<object>	No	The list of property names and property values.
	object	No	Details of the property and property value.
PropertyKey	string	No	The property name.	job
PropertyValues	string	No	The property values.	dev
IncludeDesktopCount	boolean	No	Specifies whether to return the number of cloud desktops that are assigned to the convenience user. Valid values: true false	true
IncludeDesktopGroupCount	boolean	No	Specifies whether to return the number of cloud desktop pools that are assigned to the convenience user. Valid values: true false	false
OrgId	string	No	The ID of the organization.	org-aliyun-wy-org-id
OwnerType	string	No	The activation type of the convenience account. Valid values: CreateFromManager: administrator-activated. Normal: user-activated.	Normal
ExcludeEndUserIds	array	No	The list of usernames to be precisely excluded.
	string	No	The username (EndUserId) that you want to exactly exclude during the query.	end_user_id
OrderParam	object	No	The parameter that might affect the sorting logic.
OrderField	string	No	The field that you want to sort by. Valid values: EndUserId: the username. id: the ID of the primary key. gmt_created: the creation time.	id
OrderType	string	No	The direction of the sort. Valid values: ASC: the ascending order. DESC (default): the descending order.	ASC
Status	integer	No	The status. Enumeration Value: 0: 正常状态. 11: 已离职.	0
IsQueryAllSubOrgs	boolean	No	Specifies whether to query all sub-organizations.
IncludeOrgInfo	boolean	No	Specifies whether to return the organization information.
IncludeSupportIdps	boolean	No	Specifies whether to return the supported logon types.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	DBD276B5-00FF-5E04-8EF7-5CBA09BF112A
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If not all results are returned in a query, a value is returned for the NextToken parameter. In this case, you can use the returned NextToken value to start the next query.	caeba0bbb2be03f84eb48b699f0a4883
Users	array<object>	The information about the convenience accounts.
data	object	The information about the convenience account.
Id	long	The ID of the convenience user.	12345
EndUserId	string	The username of the convenience user.	testName
Email	string	The email address of the convenience user.	testName@example.com
Phone	string	The mobile number of the convenience user.	1381111****
Status	long	The remarks on the convenience account. Valid values: 0: The convenience account is normal. 9: The convenience account is locked.	0
UserSetPropertiesModels	array<object>	The information about the properties.
userSetPropertiesModels	object	Details of the user property.
UserId	long	The ID of the convenience user that is bound to the property.	12345
UserName	string	The username of the convenience user that is bound to the property.	testName
PropertyId	long	The property ID.	12
PropertyKey	string	The property name.	department
PropertyType	integer	The property type.	2
PropertyValues	array<object>	The property values.
propertyValues	object	Details of the property value.
PropertyValueId	long	The ID of the property value.	42
PropertyValue	string	The property value.	A
DesktopCount	long	The number of cloud desktops that are assigned to the convenience user.	1
ExternalInfo	object	The additional information about the convenience user.
ExternalName	string	The account that is associated with the convenience user.	test
JobNumber	string	The account, student ID, or employee ID that is associated with the convenience user.	030801
DesktopGroupCount	long	The number of cloud desktop pools that are assigned to the convenience user. This value is returned if you set `IncludeDesktopGroupCount` to `true`.	2
OwnerType	string	The type of the account ownership. Valid values: CreateFromManager: administrator-activated Normal: user-activated	Normal
Remark	string	The remarks on the convenience user.	1
IsTenantManager	boolean	Indicates whether the convenience user is a tenant administrator. Valid values: true false	true
EnableAdminAccess	boolean	Indicates whether the convenience user is a local administrator. Valid values: true false	true
RealNickName	string	The nickname of the convenience user.	Oliver
AutoLockTime	string	The date when a convenience account is automatically locked.	2023-03-03
PasswordExpireDays	integer	By default, user account passwords do not expire. However, you can set a validity period between 30 and 365 days. Once the period expires, end users must change their password before they can log on to terminals. Note The feature is in invitational preview. If you want to use this feature, submit a ticket.	30
PasswordExpireRestDays	integer	The number of days remaining until the account password expires.	10
OrgList	array<object>	The organizations to which the user belongs.
orgList	object	The organizations to which the user belongs.
OrgId	string	The organization ID.
OrgName	string	The organization name.
OrgNamePath	string	The organization name path.
SupportLoginIdps	array<object>	The supported identity provider logon methods.
IdpInfo	object	The supported identity provider logon method.
IdpId	string	The enterprise identity provider ID.
IdpName	string	The enterprise identity provider name.

Examples

Sample success responses

JSONformat

{
  "RequestId": "DBD276B5-00FF-5E04-8EF7-5CBA09BF112A",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Users": [
    {
      "Id": 12345,
      "EndUserId": "testName",
      "Email": "testName@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "UserSetPropertiesModels": [
        {
          "UserId": 12345,
          "UserName": "testName",
          "PropertyId": 12,
          "PropertyKey": "department",
          "PropertyType": 2,
          "PropertyValues": [
            {
              "PropertyValueId": 42,
              "PropertyValue": "A"
            }
          ]
        }
      ],
      "DesktopCount": 1,
      "ExternalInfo": {
        "ExternalName": "test",
        "JobNumber": "030801"
      },
      "DesktopGroupCount": 2,
      "OwnerType": "Normal",
      "Remark": 1,
      "IsTenantManager": true,
      "EnableAdminAccess": true,
      "RealNickName": "Oliver\n",
      "AutoLockTime": "2023-03-03",
      "PasswordExpireDays": 30,
      "PasswordExpireRestDays": 10,
      "OrgList": [
        {
          "OrgId": "",
          "OrgName": "",
          "OrgNamePath": ""
        }
      ],
      "SupportLoginIdps": [
        {
          "IdpId": "",
          "IdpName": ""
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-10-20	The response structure of the API has changed	View Change Details
2025-03-24	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-12-11	The request parameters of the API has changed	View Change Details
2024-08-15	The request parameters of the API has changed	View Change Details
2024-04-09	The response structure of the API has changed	View Change Details
2023-10-25	The response structure of the API has changed	View Change Details
2021-08-10	The response structure of the API has changed	View Change Details
2021-08-10	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2021-08-10	The request parameters of the API has changed	View Change Details