All Products
Search
Document Center

Resource Access Management:ListUserBasicInfos

Last Updated:Mar 03, 2024

Queries the basic information about all RAM users.

Operation description

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

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ram:ListUserBasicInfosList
  • User
    acs:ram::{#accountId}:user/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MarkerstringNo

The marker. If part of a previous response is truncated, you can use this parameter to obtain the truncated part.

EXAMPLE
MaxItemsintegerNo

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
Tagobject []No

The tag value.

KeystringNo

The key of tag N.

Valid values of N: 1 to 20. N must be consecutive.

operator
ValuestringNo

The value of tag N.

Valid values of N: 1 to 20. N must be consecutive.

alice

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F
IsTruncatedboolean

Indicates whether the response is truncated. Valid value:

  • true
  • false
true
UserBasicInfosobject []

An array that consists of the information about the RAM user.

UserPrincipalNamestring

The logon name of the RAM user.

test@example.onaliyun.com
DisplayNamestring

The display name of the RAM user.

test
UserIdstring

The ID of the RAM user.

20732900249392****
Markerstring

The marker. If part of a previous response is truncated, you can use 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****"
      }
    ]
  },
  "Marker": "EXAMPLE"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-03-24The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.