DescribeMfaDevices - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the information about virtual multi-factor authentication (MFA) devices that are bound to convenience accounts.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	long	No	The maximum number of entries to return. Valid values: 1 to 500. Default value: 100.	100
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Set the value to the token that is obtained from the previous query.	caeba0bbb2be03f84eb48b699f0a4883
EndUserIds	array	No	The usernames of the convenience accounts.
	string	No	The username of the convenience account.	test
SerialNumbers	array	No	The serial numbers of the virtual MFA devices.
	string	No	The serial number of the virtual MFA device.	c2d9ae94-a64b-4a0d-8024-9519ca50****
AdDomain	string	No	The address of the AD office network.	cn.misumi.pri

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	33DBB8EC-6E68-4726-91C4-E09C59D9A7D8
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results.	AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp
MfaDevices	array<object>	The information about the virtual MFA devices.
data	object	The information about the virtual MFA device.
Id	long	The ID of the virtual MFA device.	36
EndUserId	string	The username of the convenience account that uses the virtual MFA device.	test
Email	string	Note This parameter is not publicly available.	username@example.com
GmtEnabled	string	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.	2021-06-22T06:20:49Z
GmtUnlock	string	The time when the locked virtual MFA device was automatically unlocked. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2021-06-23T06:20:49Z
ConsecutiveFails	integer	The number of consecutive failures to bind the virtual MFA device, or the number of authentication failures based on the virtual MFA device.	0
SerialNumber	string	The serial number of the virtual MFA device.	dc856334-446b-4035-bfbc-18af261e****
Status	string	The status of the virtual MFA device. Valid values: LOCKED UNBOUND NORMAL	NORMAL
DeviceType	string	The type of the virtual MFA device. The value can only be `TOTP_VIRTUAL`. This value indicates that the virtual MFA device follows the Time-based One-time Password (TOTP) algorithm.	TOTP_VIRTUAL

Examples

Sample success responses

JSONformat

{
  "RequestId": "33DBB8EC-6E68-4726-91C4-E09C59D9A7D8",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp",
  "MfaDevices": [
    {
      "Id": 36,
      "EndUserId": "test",
      "Email": "username@example.com",
      "GmtEnabled": "2021-06-22T06:20:49Z",
      "GmtUnlock": "2021-06-23T06:20:49Z",
      "ConsecutiveFails": 0,
      "SerialNumber": "dc856334-446b-4035-bfbc-18af261e****",
      "Status": "NORMAL",
      "DeviceType": "TOTP_VIRTUAL",
      "AdUser": {
        "EndUser": "",
        "DisplayName": "",
        "DisplayNameNew": "",
        "UserPrincipalName": ""
      }
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-08-21	The request parameters of the API has changed	View Change Details