Query virtual MFA devices for AD accounts by calling DescribeVirtualMFADevices - Elastic Desktop Service

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	DescribeVirtualMFADevices	The operation that you want to perform. Set the value to DescribeVirtualMFADevices.
OfficeSiteId	String	Yes	cn-hangzhou+dir-269345****	The ID of the workspace.
RegionId	String	Yes	cn-hangzhou	The ID of the region.
MaxResults	Integer	No	100	The maximum number of results to return. Valid values: 1 to 500. Default value: 100.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	The token that determines the start point of the query. Set the value to the NextToken value returned in the last call.
EndUserId.N	RepeatList	No	testuser	The name of the AD user.

Response parameters


Parameter	Type	Example	Description
NextToken	String	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as	The token that determines the start point of the next query. This parameter is empty if no additional results exist.
RequestId	String	FB550AAB-FB36-4A91-93F6-F4374AF65403	The ID of the request.
VirtualMFADevices	Array of VirtualMFADevice		Details of the virtual MFA devices.
ConsecutiveFails	Integer	1	The number of consecutive failures to bind the virtual MFA device, or the number of MFA failures based on the virtual MFA device.
DirectoryId	String	cn-hangzhou+dir-gx2x1dhsmu52rd****	Note This parameter is in invitational preview and unavailable for public use.
EndUserId	String	usertest	The name of the AD user who uses the virtual MFA device.
GmtEnabled	String	2020-12-20T14:52:28Z	The time when the virtual MFA device is enabled. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
GmtUnlock	String	2020-12-21T15:21:28Z	The time when the virtual MFA device is automatically unlocked after being locked. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
OfficeSiteId	String	cn-hangzhou+dir-269345****	The ID of the workspace.
SerialNumber	String	a25f297f-f2e1-4a44-bbf1-5f48a6e5****	The serial number of the virtual MFA device, which is a unique identifier.
status	String	NORMAL	The status of the virtual MFA device. The valid values include: UNBOUND: The virtual MFA device is not bound. NORMAL: The virtual MFA device is normal. LOCKED: The virtual MFA device is locked.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeVirtualMFADevices
&OfficeSiteId=cn-hangzhou+dir-269345****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeVirtualMFADevicesResponse>
  <VirtualMFADevices>
        <GmtEnabled>2020-12-20T14:52:28Z</GmtEnabled>
        <OfficeSiteId>cn-hangzhou+dir-269345****</OfficeSiteId>
        <EndUserId>usertest</EndUserId>
        <DirectoryId>cn-hangzhou+dir-gx2x1dhsmu52rd****</DirectoryId>
        <SerialNumber>a25f297f-f2e1-4a44-bbf1-5f48a6e5****</SerialNumber>
        <ConsecutiveFails>1</ConsecutiveFails>
        <GmtUnlock>2020-12-21T15:21:28Z</GmtUnlock>
        <status>NORMAL</status>
  </VirtualMFADevices>
  <RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>
  <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as</NextToken>
</DescribeVirtualMFADevicesResponse>

JSON format

{
    "VirtualMFADevices": [
        {
            "GmtEnabled": "2020-12-20T14:52:28Z",
            "OfficeSiteId": "cn-hangzhou+dir-269345****",
            "EndUserId": "usertest",
            "DirectoryId": "cn-hangzhou+dir-gx2x1dhsmu52rd****",
            "SerialNumber": "a25f297f-f2e1-4a44-bbf1-5f48a6e5****",
            "ConsecutiveFails": "1",
            "GmtUnlock": "2020-12-21T15:21:28Z",
            "status": "NORMAL"
        }
    ],
    "RequestId": "FB550AAB-FB36-4A91-93F6-F4374AF65403",
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as"
}