ListUsers - Resource Access Management - Alibaba Cloud Documentation Center

Queries the details of all RAM users.

Operation description

You can call the following API operations to query the details of all RAM users:

ListUsers: queries the details of all RAM users.
ListUserBasicInfos: queries the basic information about all RAM users. The basic information includes only the logon names (UserPrincipalName), display names (DisplayName), and user IDs (UserId).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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
ram:ListUsers	List	User acs:ram::{#accountId}:user/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
Marker	string	No	The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part.	EXAMPLE
MaxItems	integer	No	The number of entries per page. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be true. Valid values: 1 to 1000. Default value: 1000.	1000
Tag	object []	No	The tags. A maximum number of 20 tags are supported.
Key	string	No	The key of tag N. Valid values of N: 1 to 20. N must be consecutive.	operator
Value	string	No	The value of tag N. Valid values of N: 1 to 20. N must be consecutive.	alice

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4B450CA1-36E8-4AA2-8461-86B42BF4CC4E
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true false	true
Marker	string	The parameter that is used to obtain the truncated part. It takes effect only when `IsTruncated` is set to `true`.	EXAMPLE
Users	object []	The details of the RAM user.
DisplayName	string	The display name of the RAM user.	test
UserPrincipalName	string	The logon name of the RAM user.	test@example.onaliyun.com
Email	string	The email address of the RAM user. Note This parameter applies only to the Alibaba Cloud China site (aliyun.com).	alice@example.com
UpdateDate	string	The point in time when the information about the RAM user was last modified. The time is displayed in UTC.	2020-10-13T09:19:49Z
MobilePhone	string	The mobile phone number of the RAM user. Note This parameter applies only to the Alibaba Cloud China site (aliyun.com).	86-1868888****
UserId	string	The ID of the RAM user.	20732900249392****
Comments	string	The description.	This is a cloud computing engineer.
LastLoginDate	string	The timestamp when the RAM user last logged on to the console.	2020-10-12T09:12:00Z
CreateDate	string	The point in time when the RAM user was created. The time is displayed in UTC.	2020-10-12T09:12:00Z
ProvisionType	string	The source of the RAM user. Valid values: Manual: The RAM user is manually created in the RAM console. SCIM: The RAM user is mapped by using System for Cross-domain Identity Management (SCIM). CloudSSO: The RAM user is mapped from a CloudSSO user.	CloudSSO
Tags	object []	The tags.
TagKey	string	The key of the tag.	oparator
TagValue	string	The value of the tag	alice

Examples

Sample success responses

JSONformat

{
  "RequestId": "4B450CA1-36E8-4AA2-8461-86B42BF4CC4E",
  "IsTruncated": true,
  "Marker": "EXAMPLE",
  "Users": {
    "User": [
      {
        "DisplayName": "test",
        "UserPrincipalName": "test@example.onaliyun.com",
        "Email": "alice@example.com",
        "UpdateDate": "2020-10-13T09:19:49Z",
        "MobilePhone": "86-1868888****",
        "UserId": "20732900249392****",
        "Comments": "This is a cloud computing engineer.",
        "LastLoginDate": "2020-10-12T09:12:00Z",
        "CreateDate": "2020-10-12T09:12:00Z",
        "ProvisionType": "CloudSSO",
        "Tags": {
          "Tag": [
            {
              "TagKey": "oparator",
              "TagValue": "alice"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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