ListUsers-阿里云帮助中心

Queries the user list.

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

gemp:ListUsers

get

*All Resource

*

None

Request syntax

POST /user/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
username	string	No	The personnel name.	Mr. Zhang
phone	string	No	The personnel phone number.	1887879****
ramId	string	No	The ID of the Resource Access Management (RAM) users.	1344383
scene	integer	No	The query scene. Valid values: 0: User list. 1: Drop-down list.	0
clientToken	string	No	The idempotency token.	c26f36de-1ec8-496a-a828-880676c5ef81
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The page size.	10
synergyChannel	string	No	The mobile application channel.	DINGDING

Response elements

Element	Type	Description	Example
	object	The response structure.
requestId	string	The request ID.	c26f36de-1ec8-496a-a828-880676c5ef81
data	array<object>	The returned result.
	object	The user information.
userId	integer	The user ID.	1234
ramId	integer	The RAM user ID.	53624523
username	string	The username.	Mr. Zhang
phone	string	The phone number.	1887879****
email	string	The email address.	2345****@qq.com
isEditableUser	integer	Specifies whether the user is editable. Valid values: 1: Yes. 0: No.	1
accountType	integer	The type of Resource Access Management (RAM) users. Valid values: 0: Alibaba Cloud account. 1: RAM user.	1
appAccount	string	The mobile application account.	23456tre
synergyChannel	string	The mobile application synergy channel.	DINGDING
isRelated	string	Specifies whether the user is associated. Valid values: RELATED: Associated. NOT_RELATED: Not associated.	RELATED
isOperation	integer	Specifies whether operations such as deletion and dissociation can be performed. Valid values: 1: Operable. 0: Not operable.	1
isRam	integer	Specifies whether the account is an Alibaba Cloud account. Valid values: 1: Yes. 0: No.	1
roleIdList	array	The list of role IDs.
	integer	The list of role IDs.	10001
roleNameList	array	The list of role names.
	string	The list of role names.	Test
isActive	integer	Specifies whether the account is activated. Valid values: 1: Activated. 0: Not activated.	1
gmtCreate	string	The creation time.	2021-09-09 09:09:09
gmtActive	string	The account activation time.	2021-09-09 09:09:09
totalCount	integer	The total number of entries.	100
pageNumber	integer	The page number.	1
pageSize	integer	The page size.	10

Examples

Success response

JSON format

{
  "requestId": "c26f36de-1ec8-496a-a828-880676c5ef81",
  "data": [
    {
      "userId": 1234,
      "ramId": 53624523,
      "username": "Mr. Zhang",
      "phone": "1887879****",
      "email": "2345****@qq.com",
      "isEditableUser": 0,
      "accountType": 1,
      "appAccount": "23456tre",
      "synergyChannel": "DINGDING",
      "isRelated": "RELATED",
      "isOperation": 1,
      "isRam": 1,
      "roleIdList": [
        10001
      ],
      "roleNameList": [
        "Test"
      ],
      "isActive": 1,
      "gmtCreate": "2021-09-09 09:09:09",
      "gmtActive": "2021-09-09 09:09:09"
    }
  ],
  "totalCount": 100,
  "pageNumber": 1,
  "pageSize": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.