All Products
Search
Document Center

Resource Access Management:ListVirtualMFADevices

Last Updated:Jul 25, 2024

Queries multi-factor authentication (MFA) devices.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
MarkerstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.``

When you call the operation for the first time, if the total number of returned entries exceeds the value of MaxItems, the entries are truncated. The system returns entries based on the value of MaxItems and does not return the excess entries. In this case, the value of the response parameter IsTruncated is true, and Marker is returned. In the next call, you can use the value of Marker and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of the IsTruncated parameter becomes false. This way, all entries are returned.

EXAMPLE
MaxItemsintegerNo

The number of entries per page.

Valid values: 1 to 100.

Default value: 100.

100

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

VirtualMFADevicesarray<object>

The information about the MFA device.

object
SerialNumberstring

The serial number of the MFA device.

acs:ram::177242285274****:mfa/test
Userobject

The information of the RAM user that has an MFA device bound.

UserPrincipalNamestring

The logon name of the RAM user.

test@177242285274****.onaliyun.com
DisplayNamestring

The display name of the RAM user.

test
UserIdstring

The ID of the RAM user.

20732900249392****
ActivateDatestring

The time when the MFA device was activated.

2020-10-16T06:02:09Z
RequestIdstring

The request ID.

32272612-DF82-485E-8BA9-AFA4E0C3D0BA
IsTruncatedboolean

Indicates whether the response is truncated. Valid values:

  • true
  • false
true
Markerstring

The pagination token that is used in the next request to retrieve a new page of results.

Note This parameter is returned only when IsTruncated is true.
EXAMPLE

Examples

Sample success responses

JSONformat

{
  "VirtualMFADevices": {
    "VirtualMFADevice": [
      {
        "SerialNumber": "acs:ram::177242285274****:mfa/test",
        "User": {
          "UserPrincipalName": "test@177242285274****.onaliyun.com",
          "DisplayName": "test",
          "UserId": "20732900249392****"
        },
        "ActivateDate": "2020-10-16T06:02:09Z"
      }
    ]
  },
  "RequestId": "32272612-DF82-485E-8BA9-AFA4E0C3D0BA",
  "IsTruncated": true,
  "Marker": "EXAMPLE"
}

Error codes

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