Queries the information about virtual MFA devices that are bound to convenience users.

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 DescribeMfaDevices

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

MaxResults Long No 100

The maximum number of entries to return. Valid values: 1 to 500.

Default value: 100.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The query token. Set the value to the NextToken value returned in the last call.

EndUserIds.N RepeatList No test

The username of convenience user N.

SerialNumbers.N RepeatList No c2d9ae94-a64b-4a0d-8024-9519ca50****

The serial number of the virtual MFA device, which is a unique identifier.

Response parameters

Parameter Type Example Description
MfaDevices Array of data

Details about the virtual MFA devices.

ConsecutiveFails Integer 0

The number of consecutive failures to bind the virtual MFA device, or the number of MFA failures based on the virtual MFA device.

DeviceType String TOTP_VIRTUAL

The types of the virtual MFA device. Set the value to TOTP_VIRTUAL, which indicates that the virtual MFA devices follow the Time-based One-time Password (TOTP) algorithm.

Email String test@example***.com

This parameter is unavailable.

EndUserId String test

The username of the convenience user that uses the virtual MFA device.

GmtEnabled String 2021-06-22T06:20:49Z

The time when the virtual MFA device was enabled. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

GmtUnlock String 2021-06-23T06:20:49Z

The time when a locked virtual MFA device is automatically unlocked. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Id Long 36

This parameter is unavailable.

SerialNumber String dc856334-446b-4035-bfbc-18af261e****

The serial number of the virtual MFA device, which is a unique identifier.

Status String NORMAL

The status of the virtual MFA device. Valid values:

  • UNBOUND
  • NORMAL
  • LOCKED
NextToken String AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp

The token that determines the start point of the next query.

RequestId String 33DBB8EC-6E68-4726-91C4-E09C59D9A7D8

The ID of the request.

Examples

Sample requests

https://eds-user.cn-shanghai.aliyuncs.com/?Action=DescribeMfaDevices
&<Common request parameters>

Sample success responses

XML format

<DescribeMfaDevicesResponse>
      <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp</NextToken>
      <RequestId>8C09C087-99C3-43F0-BFEA-03E651E04696</RequestId>
      <MfaDevices>
            <Status>NORMAL</Status>
            <DeviceType>TOTP_VIRTUAL</DeviceType>
            <GmtEnabled>2021-06-22T06:20:49Z</GmtEnabled>
            <EndUserId>test</EndUserId>
            <SerialNumber>dc856334-446b-4035-bfbc-18af261e****</SerialNumber>
            <ConsecutiveFails>0</ConsecutiveFails>
            <Id>36</Id>
      </MfaDevices>
</DescribeMfaDevicesResponse>

JSON format

{
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp",
    "RequestId": "8C09C087-99C3-43F0-BFEA-03E651E04696",
    "MfaDevices": [
        {
            "Status": "NORMAL",
            "DeviceType": "TOTP_VIRTUAL",
            "GmtEnabled": "2021-06-22T06:20:49Z",
            "EndUserId": "test",
            "SerialNumber": "dc856334-446b-4035-bfbc-18af261e****",
            "ConsecutiveFails": 0,
            "Id": 36
        }
    ]
}