DescribeUsers - Cloud Phone - Alibaba Cloud Documentation Center

Queries information of a convenience account, such as the username, email address, and nickname.

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:DescribeUsers	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	long	No	The number of entries per page. Valid values: 1 to 500 Default value: 500	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 return value of NextToken to perform the next query.	caeba0bbb2be03f84eb48b699f0a****
Filter	string	No	The string that is used for fuzzy search. You perform fuzzy search by username (EndUserId) and email address (Email). Wildcard characters () are supported. For example, if you set this parameter to `am`, usernames or email addresses that start with `a` and end with `m` are returned.	a*m
EndUserIds	array	No	The list of usernames that must be exactly matched.
	string	No	Details of the username (EndUserId) that is used to match the user that you want to query.	alice
ExcludeEndUserIds	array	No	The list of usernames to be exactly excluded.
	string	No	The username (EndUserId) that you want to exclude during the query.	tony
OrgId	string	No	The ID of the organization in which you want to query users.	org-4mdgc1cocc59z****
GroupId	string	No	The ID of the organization in which you want to query convenience users.	ug-12341234****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken	string	The token that determines the start point of the next query. If this parameter is left empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
Users	array<object>	The information about the convenience users.
data	object
Id	long	The ID of the convenience user.	4205**
EndUserId	string	The username of the convenience user.	alice
Email	string	The email address of the convenience user.	username@example.com
Phone	string	The mobile number of the convenience user. If you leave this parameter empty, the value of this parameter is not returned.	1381111****
Status	long	The status of the convenience user. Valid values: 0: The convenience user is normal. 9: The convenience user is locked. Enumeration Value: 0: The user status is normal.. 9: The user is locked..	0
OwnerType	string	The type of the convenience account. Administrator-activated type: The administrator specifies the username and password of the convenience account. User notifications such as password reset notifications are sent to the email address or mobile number of the administrator. User-activated type: The administrator specifies the username and the email address or mobile number of a convenience user. Notifications such as activation notifications that contain the default password are sent to the email address or mobile number of the convenience user. Valid values: CreateFromManager : administrator-activated Normal : user-activated	Normal
Remark	string	The remarks on the convenience user.	TestUser
OrgId	string	The ID of the organization to which the convenience user belongs. Note This parameter will be deprecated in the future.	org-4mdgc1cocc59z****
WyId	string	The globally unique ID of the convenience user.	41fd1254d8f7****
IsTenantManager	boolean	Indicates whether the convenience user is an administrator. If the convenience user is of the administrator-activated type, you must specify a user administrator. Notifications such as password reset on a client are sent to the email address or mobile number of the user administrator. For more information, see Create a convenience user.	true
Groups	array<object>	The user groups to which the convenience user belongs.
group	object
GroupId	string	The ID of the user group.	ug-12341234****
GroupName	string	The name of the user group.	User Group 1
Orgs	array<object>	The organizations to which the convenience user belongs.
org	object
OrgId	string	The organization ID.	org-4mdgc1cocc59z****
OrgName	string	The organization name.	Organization 1
Avatar	string	The profile picture of the convenience user.	https://cdn.*****
Address	string	The work address of the convenience user.	Hangzhou \\\*
JobNumber	string	The employee number of the convenience user.	A10000**
NickName	string	The nickname of the convenience user.	Lee

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Users": [
    {
      "Id": 0,
      "EndUserId": "alice",
      "Email": "username@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "OwnerType": "Normal",
      "Remark": "TestUser",
      "OrgId": "org-4mdgc1cocc59z****",
      "WyId": "41fd1254d8f7****",
      "IsTenantManager": true,
      "Groups": [
        {
          "GroupId": "ug-12341234****",
          "GroupName": "User Group 1\n"
        }
      ],
      "Orgs": [
        {
          "OrgId": "org-4mdgc1cocc59z****",
          "OrgName": "Organization 1\n"
        }
      ],
      "Avatar": "https://cdn.*****",
      "Address": "Hangzhou \\*\\*\\*\n",
      "JobNumber": "A10000**",
      "NickName": "Lee\n"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-01-02	The request parameters of the API has changed	View Change Details
2024-09-24	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-07-19	The response structure of the API has changed	View Change Details
2024-01-24	The request parameters of the API has changed	View Change Details
2023-12-11	The request parameters of the API has changed	View Change Details
2023-09-24	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-08-06	The response structure of the API has changed	View Change Details
2021-04-02	Add Operation	View Change Details