Queries the details of all RAM users.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListUsers

The operation that you want to perform. Set the value to ListUsers.

Marker String No EXAMPLE

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

MaxItems Integer No 1000

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: 1000.

Tag.N.Key String No operator

The key of tag N.

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

Tag.N.Value String No alice

The value of tag N.

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

Response parameters

Parameter Type Example Description
RequestId String 4B450CA1-36E8-4AA2-8461-86B42BF4CC4E

The ID of the request.

IsTruncated Boolean true

Indicates whether the response is truncated. Valid values:

  • true
  • false
Marker String EXAMPLE

The parameter that is used to obtain the truncated part. It takes effect only when IsTruncated is set to true.

Users Array of User

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

User
DisplayName String test

The display name of the RAM user.

UserPrincipalName String test@example.onaliyun.com

The logon name of the RAM user.

Email String alice@example.com

The email address of the RAM user.

Note This parameter is valid only on the China site (aliyun.com).
UpdateDate String 2020-10-13T09:19:49Z

The time when the information about the RAM user was updated.

MobilePhone String 86-1868888****

The mobile phone number of the RAM user.

Note This parameter is valid only on the China site (aliyun.com).
UserId String 20732900249392****

The ID of the RAM user.

Comments String This is a cloud computing engineer.

The description.

LastLoginDate String 2020-10-12T09:12:00Z

The last time when the RAM user logged on to the Alibaba Cloud Management Console.

CreateDate String 2020-10-12T09:12:00Z

The time when the RAM user was created.

ProvisionType String CloudSSO

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.
Tags Array of Tag

An array that consists of tags.

Tag
TagKey String oparator

The tag key.

TagValue String alice

The tag value.

Examples

Sample requests

https://[Endpoint]/?Action=ListUsers
&Marker=EXAMPLE
&MaxItems=1000
&Tag.1.Key=operator
&Tag.1.Value=alice
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4B450CA1-36E8-4AA2-8461-86B42BF4CC4E",
  "IsTruncated" : true,
  "Marker" : "EXAMPLE",
  "Users" : [ {
    "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" : [ {
      "TagKey" : "oparator",
      "TagValue" : "alice"
    } ]
  } ]
}

Error codes

For a list of error codes, see Service error codes.