FilterUsers - - Alibaba Cloud Documentation Center

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	FilterUsers	The operation that you want to perform. Set the value to FilterUsers.
MaxResults	Long	No	10	The number of entries to return on each page.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	The token that is used for the next query.
Filter	String	No	test	The string that you enter for a fuzzy search. You can enter a string to match the username or email address.
IncludeDesktopCount	Boolean	No	true	Specifies whether to return the number of cloud desktops that are assigned to the convenience user.
IncludeDesktopGroupCount	Boolean	No	false	Specifies whether to return the number of cloud desktop groups that are assigned to the convenience user.
PropertyFilterParam.N.PropertyId	Long	No	123	The property ID of parameter N.
PropertyFilterParam.N.PropertyValueIds	String	No	test	The property value IDs of parameter N.

Response parameters


Parameter	Type	Example	Description
RequestId	String	DBD276B5-00FF-5E04-8EF7-5CBA09BF112A	The ID of the request.
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	The token that is used for the next query. If this parameter is empty, all results have been returned.
Users	Array of data		Details about convenience users.
Id	Long	12345	The ID of the convenience user.
EndUserId	String	testName	The name of the convenience user.
Email	String	testName@example.com	The email address of the convenience user.
Phone	String	1871234****	The mobile number of the convenience user.
Status	Long	0	The status of the convenience user. Valid values: 0: normal 9: locked
UserSetPropertiesModels	Array of userSetPropertiesModels		Details about user properties.
UserId	Long	12345	The ID of the convenience user that is bound to the property.
UserName	String	testName	The name of the convenience user that is bound to the property.
PropertyId	Long	12	The ID of the property.
PropertyKey	String	department	The name of the property.
PropertyType	Integer	2	The type of the property.
PropertyValues	Array of propertyValues		Details about property values.
PropertyValueId	Long	42	The ID of the property value.
PropertyValue	String	A	The value of the property.
DesktopCount	Long	1	The number of cloud desktops that are assigned to the convenience user.
ExternalInfo	Object		The additional information about the convenience user.
ExternalName	String	test	The name of the external system account to which the convenience user is connected.
JobNumber	String	030801	The student ID or employee ID of the external system account that is connected to the convenience user.
DesktopGroupCount	Long	2	The number of authorized desktop groups that are owned by the convenience user. This value is returned if the value of the IncludeDesktopGroupCount parameter is true.

Examples

Sample requests

https://eds-user.cn-shanghai.aliyuncs.com/?Action=FilterUsers
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<FilterUsersResponse>
    <RequestId>DBD276B5-00FF-5E04-8EF7-5CBA09BF112A</RequestId>
    <Users>
        <Status>0</Status>
        <EndUserId>testName</EndUserId>
        <Email>testName@example.com</Email>
        <Phone/>
        <Id>12345</Id>
        <UserSetPropertiesModels>
            <PropertyValues>
                <PropertyValueId>184</PropertyValueId>
                <PropertyValue>true</PropertyValue>
            </PropertyValues>
            <UserId>12345</UserId>
            <PropertyType>1</PropertyType>
            <PropertyKey>enableAdminAccess</PropertyKey>
            <PropertyId>145</PropertyId>
        </UserSetPropertiesModels>
        <UserSetPropertiesModels>
            <PropertyValues>
                <PropertyValueId>42</PropertyValueId>
                <PropertyValue>A</PropertyValue>
            </PropertyValues>
            <UserId>12345</UserId>
            <PropertyType>2</PropertyType>
            <PropertyKey>department</PropertyKey>
            <PropertyId>30</PropertyId>
        </UserSetPropertiesModels>
    </Users>
</FilterUsersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "DBD276B5-00FF-5E04-8EF7-5CBA09BF112A",
  "Users" : [ {
    "Status" : 0,
    "EndUserId" : "testName",
    "Email" : "testName@example.com",
    "Phone" : "",
    "Id" : 12345,
    "UserSetPropertiesModels" : [ {
      "PropertyValues" : [ {
        "PropertyValueId" : 184,
        "PropertyValue" : "true"
      } ],
      "UserId" : 12345,
      "PropertyType" : 1,
      "PropertyKey" : "enableAdminAccess",
      "PropertyId" : 145
    }, {
      "PropertyValues" : [ {
        "PropertyValueId" : 42,
        "PropertyValue" : "A"
      } ],
      "UserId" : 12345,
      "PropertyType" : 2,
      "PropertyKey" : "department",
      "PropertyId" : 30
    } ]
  } ]
}