ListUserBasicInfos - Resource Access Management - Alibaba Cloud Documentation Center

Queries the basic information about all Resource Access Management (RAM) users.

Operation description

You can call the following API operations to query information about 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

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
ram:ListUserBasicInfos	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 to return. 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: 100.	100
Tag	array<object>	No	The tags.
	object	No	The tag.
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
Status	string	No	The status of the RAM users that you want to query. Valid values: active, freeze, and active,freeze. If you set the value to active,freeze, RAM users in both active and freeze states are queried. If you leave the parameter empty, the value active is used by default. If the Tag parameter is specified, you cannot specify the Status parameter. In this case, RAM users in both states are queried.	active

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true false	true
UserBasicInfos	array<object>	The basic information about the RAM users.
UserBasicInfo	object	The basic information about the RAM user.
UserPrincipalName	string	The logon name of the RAM user.	test@example.onaliyun.com
DisplayName	string	The display name of the RAM user.	test
UserId	string	The ID of the RAM user.	20732900249392****
Status	string	The status of the RAM user.	active
Marker	string	The `marker`. This parameter is returned only if the value of `IsTruncated` is `true`. If the parameter is returned, you can call this operation again and set this parameter to obtain the truncated part.``	EXAMPLE

Examples

Sample success responses

JSONformat

{
  "RequestId": "EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F",
  "IsTruncated": true,
  "UserBasicInfos": {
    "UserBasicInfo": [
      {
        "UserPrincipalName": "test@example.onaliyun.com",
        "DisplayName": "test",
        "UserId": "20732900249392****",
        "Status": "active"
      }
    ]
  },
  "Marker": "EXAMPLE"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-29	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-08-14	API Description Update	View Change Details
2023-03-24	The response structure of the API has changed	View Change Details