DescribeUsers - Query convenience account information - Elastic Desktop Service

Queries convenience account information, such as usernames, email addresses, and remarks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeUsers

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The number of entries per page for a paged query. Valid values: 1 to 500. Default value: 200.	10
NextToken	string	No	The token for the next query. You do not need to set this parameter for the first call. If the query results are not completely returned, the returned NextToken is not empty. You can include the returned NextToken in the next request to continue the query.	caeba0bbb2be03f84eb48b699f0a****
Filter	string	No	The fuzzy search string. This parameter supports matching by username (EndUserId) and email (Email). This field supports wildcards (). For example, if you set this field to `am`, all results whose username or email starts with `a` and ends with `m` are returned.	a*m
FilterMap	object	No
	string	No
EndUserIds	array	No	The list of usernames (EndUserId) for exact match.
	string	No	Performs an exact match by username (EndUserId) to query account information with the specified username.	alice
ExcludeEndUserIds	array	No	The list of usernames (EndUserId) to exclude exactly.
	string	No	Excludes the username (EndUserId) exactly to query the account list that does not contain the specified username.	tony
OrgId	string	No	Performs an exact match by organization ID to query the list of accounts that belong to the specified organization.	org-4mdgc1cocc59z****
GroupId	string	No	Performs an exact match by user group ID to query the list of accounts that belong to the specified user group.	ug-12341234****
ShowExtras	object	No	Note This parameter is not publicly available.	null
	any	No	The key is one of the following types, and the value is a boolean. Passing true indicates that you want to query the specified information. Membership in groups and departments is returned by default. - `Group`: groups that the user belongs to. - `Org`: departments that the user belongs to. - `ResourcesCount`: number of assigned resources. - `Properties`: user attributes.	ResourcesCount: true
FilterWithAssignedResources	object	No	Note This parameter is not publicly available.	null
	boolean	No	The key is one of the following types, and the value is a boolean. Passing true filters users who are assigned the specified cloud resource. - `Desktop`: a cloud desktop. - `DesktopGroup`: a shared cloud desktop. - `CloudDrive`: an enterprise cloud drive (user's personal drive). - `App`: a cloud application.	DesktopGroup: true
IsQueryAllSubOrgs	boolean	No	Queries extended user information.	true
FilterWithAssignedResource	object	No	Filters users based on whether cloud resources are assigned.
	string	No	The key is one of the following types, and the value is a Boolean type. Set the value to true to filter users who are assigned the specified cloud resource. Desktop: cloud computer. DesktopGroup: shared cloud computer. CloudDrive: enterprise cloud drive (personal drive). App: cloud application.	DesktopGroup: true
Status	integer	No	Specifies whether to query users in sub-organizations.	true
ExcludeGroupId	string	No
BusinessChannel	string	No	The status.	ENTERPRISE
		No
		No	The channel.	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken	string	The token for the next query. If NextToken is empty, no more results exist.	caeba0bbb2be03f84eb48b699f0a4883
Count	integer	The total number of users that meet the query conditions
Users	array<object>	The collection of convenience account information.
	array<object>	The collection of convenience account information.
Id	integer	The convenience account ID.	4205**
EndUserId	string	The username.	alice
Email	string	The email address.	username@example.com
Phone	string	The phone number. This parameter is not returned if it is not set.	1381111****
Status	integer	The status. Valid values: 0 : Normal. 9 : Locked.	0
OwnerType	string	The convenience account type, which includes: Administrator-activated type: The administrator sets the username and password. User notifications such as password resets are sent to the administrator's email or phone. User-activated type: The administrator sets the username and the user's email or phone for receiving notifications. User notifications such as cloud computer provisioning notifications (including the initial password) are sent to the user's email or phone. Valid values: CreateFromManager : Administrator-activated. Normal : User-activated.	Normal
Remark	string	The remark of the convenience account.	Test user.
OrgId	string	The department ID to which the convenience account belongs. Note This parameter will be deprecated soon.	org-4mdgc1cocc59z****
WyId	string	The globally unique ID of the convenience account.	41fd1254d8f7****
IsTenantManager	boolean	Indicates whether the user is a user administrator. If the convenience account is of the administrator-activated type, a user administrator must be specified. Notifications such as password resets initiated by end users through the client are sent to the user administrator's email or phone. For more information, see Create a convenience account.	true
Groups	array<object>	The collection of user groups to which the convenience account belongs.
	object	The properties of the user group to which the convenience account belongs.
GroupId	string	The user group ID.	ug-12341234****
GroupName	string	The user group name.	UserGroup1
Orgs	array<object>	The collection of departments to which the convenience account belongs.
	object	The properties of the department to which the convenience account belongs.
OrgId	string	The department ID.	org-4mdgc1cocc59z****
OrgName	string	The department name.	Department1
OrgNamePath	string
Avatar	string	The URL of the user's profile picture.	https://cdn.*****
Address	string	The work address of the user.	Hangzhou ***
NickName	string	The nickname of the user. The value is determined in the following order: RealNickName Remark EndUserId	Li**
RealNickName	string	The display name of the user.	Li**
JobNumber	string	The employee ID of the user.	A10000**
Extras	object	The extended user information.
AssignedResourceCount	object	The number of assigned cloud resources.
	any	Supported cloud resource types: Desktop: cloud computer. DesktopGroup: shared cloud computer. CloudDrive: enterprise cloud drive (personal drive). APP: cloud application.	Desktop: 3
ResourcePolicyList	array<object>
	object
PolicyId	string
PolicyName	string
ExternalName	string	The username imported from an external source. Note This field is not publicly available.	Ma**
Properties	array<object>	The user properties.
	object	The property list.
Key	string	The property name.	Role
Value	string	The property value.	Student
EnableAdminAccess	boolean	Indicates whether administrator access permissions are enabled.
PasswordExpireDays	integer
PasswordExpireRestDays	integer

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Count": 0,
  "Users": [
    {
      "Id": 0,
      "EndUserId": "alice",
      "Email": "username@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "OwnerType": "Normal",
      "Remark": "Test user.",
      "OrgId": "org-4mdgc1cocc59z****",
      "WyId": "41fd1254d8f7****",
      "IsTenantManager": true,
      "Groups": [
        {
          "GroupId": "ug-12341234****",
          "GroupName": "用户组1"
        }
      ],
      "Orgs": [
        {
          "OrgId": "org-4mdgc1cocc59z****",
          "OrgName": "部门1",
          "OrgNamePath": ""
        }
      ],
      "Avatar": "https://cdn.*****",
      "Address": "杭州市***",
      "NickName": "李**",
      "RealNickName": "李**",
      "JobNumber": "A10000**",
      "Extras": {
        "AssignedResourceCount": {
          "key": "Desktop: 3"
        },
        "ResourcePolicyList": [
          {
            "PolicyId": "",
            "PolicyName": ""
          }
        ]
      },
      "ExternalName": "马**",
      "Properties": [
        {
          "Key": "Role",
          "Value": "Student"
        }
      ],
      "EnableAdminAccess": false,
      "PasswordExpireDays": 0,
      "PasswordExpireRestDays": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.