Use DescribeUsers to query convenience users - App Streaming - Alibaba Cloud - App Streaming

Retrieves directory account information, including the username, email address, and display name.

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 to return on each page. Valid values: 1 to 500. Default value: 200.	10
NextToken	string	No	The token that is used to start the next query. If the number of entries returned exceeds the value of MaxResults, a token is returned. You can use this token in the next query to continue the query.	caeba0bbb2be03f84eb48b699f0a****
Filter	string	No	The filter for a fuzzy search. The filter matches usernames (EndUserId) and email addresses (Email). This parameter supports the wildcard character (). For example, if you set this parameter to `am`, all results whose usernames or email addresses start with `a` and end with `m` are returned.	a*m
FilterMap	object	No
	string	No
EndUserIds	array	No	The list of usernames (EndUserId) that you want to exactly match.
	string	No	Performs an exact match by username (EndUserId) to query the information of the account that has the same username.	alice
ExcludeEndUserIds	array	No	The list of usernames (EndUserId) that you want to exactly exclude.
	string	No	Excludes the specified username (EndUserId) from a query to obtain a list of accounts that do not contain the username.	tony
OrgId	string	No	Performs an exact match by organization ID to query the list of accounts that belong to the organization.	org-4mdgc1cocc59z****
GroupId	string	No	Performs an exact match by user group ID to query the list of accounts that belong to the user group.	ug-12341234****
ShowExtras	object	No	Note This parameter is not available to the public.
	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 available to the public.
	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 information about the user.	true
FilterWithAssignedResource	object	No	Filters users by whether a cloud resource is assigned.
	string	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.	App:aig-jfgmanbo****
Status	integer	No	Specifies whether to query users in suborganizations.
ExcludeGroupId	string	No
BusinessChannel	string	No	Status	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken	string	The token to start the next query. If this parameter is empty, all results have been returned.	caeba0bbb2be03f84eb48b699f0a4883
Users	array<object>	The details of the convenience accounts.
	array<object>	The details of the convenience accounts.
Id	integer	The ID of the convenience account.	4205**
EndUserId	string	The end user ID.	alice
Email	string	The email address.	username@example.com
Phone	string	The phone number. This parameter is returned only if a phone number is set.	1381111****
Status	integer	The status of the convenience account. Valid values: 0 : Enabled 9 : Locked	0
OwnerType	string	The type of the convenience account. The account can be activated in one of the following ways: Tenant manager-activated: The tenant manager sets the username and password. Notifications such as password resets are sent to the tenant manager's email address or mobile phone. End user-activated: The tenant manager sets the username and the end user's email address or mobile phone. Notifications for the end user, such as the initial password for the cloud desktop, are sent to the end user's email address or mobile phone. Valid values: CreateFromManager : The convenience account is activated by a tenant manager. Normal : The convenience account is activated by an end user.	Normal
Remark	string	The note about the convenience account.	Test user.
OrgId	string	The ID of the organization to which the convenience account belongs. Note This parameter is deprecated and may be removed in a future release.	org-4mdgc1cocc59z****
WyId	string	The globally unique ID of the convenience account.	41fd1254d8f7****
IsTenantManager	boolean	Indicates whether the user is a tenant manager. When you create a convenience account of the `CreateFromManager` type, you must specify a tenant manager. Notifications, such as password resets initiated by an end user from a client, are sent to the tenant manager's email or mobile phone. For more information, see Create a convenience account.	true
Groups	array<object>	The user groups to which the convenience account belongs.
	object	Details of a user group to which the convenience account belongs.
GroupId	string	The ID of the user group.	ug-12341234****
GroupName	string	The name of the user group.	用户组1
Orgs	array<object>	The organizations to which the convenience account belongs.
	object	Details of an organization to which the convenience account belongs.
OrgId	string	The ID of the organization.	org-4mdgc1cocc59z****
OrgName	string	The name of the organization.	部门1
OrgNamePath	string
Avatar	string	The URL of the user's avatar.	https://cdn.*****
Address	string	The work address of the user.	杭州市***
NickName	string	The nickname of the user. The value is determined from the following parameters, in order of priority: `RealNickName` `Remark` `EndUserId`	李**
RealNickName	string	The display name of the user.	李**
JobNumber	string	The employee ID.	A10000**
Extras	object	The extended properties of the user.
AssignedResourceCount	object	The number of assigned cloud resources.
	any	The key specifies the resource type, and the value specifies the resource count. The following resource types are supported: `Desktop`: cloud desktops. `DesktopGroup`: desktop groups. `CloudDrive`: cloud drives (personal drives for end users). `APP`: cloud applications.	Desktop: 3
ResourcePolicyList	array<object>
	object
PolicyId	string
PolicyName	string
ExternalName	string	The name of the user imported from an external system. Note This parameter is for internal use only.	马**
Properties	array<object>	A list of custom properties for the user.
	object	A key-value pair that represents a custom property.
Key	string	The property key.	Role
Value	string	The property value.	Student
EnableAdminAccess	boolean	Indicates whether administrator access is enabled.
PasswordExpireDays	integer
PasswordExpireRestDays	integer

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "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.