DescribeVirtualMFADevices - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries multi-factor authentication (MFA) devices that are bound to an Active Directory (AD) account.

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
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
MaxResults	integer	No	The number of entries per page. 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. You must specify the token that is obtained from the previous query as the value of NextToken.	caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteId	string	Yes	The ID of the workspace.	cn-hangzhou+dir-269345****
EndUserId	array	No	The names of the AD users.
	string	No	The name of the AD user.	testuser

Response parameters

Parameter	Type	Description	Example
	object	The information that is returned.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as
RequestId	string	The request ID.	FB550AAB-FB36-4A91-93F6-F4374AF65403
VirtualMFADevices	array<object>	Details of the virtual MFA devices.
VirtualMFADevice	object
SerialNumber	string	The serial number of the virtual MFA device, which is a unique identifier.	a25f297f-f2e1-4a44-bbf1-5f48a6e5****
GmtUnlock	string	The time when a 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.	2020-12-21T15:21:28Z
EndUserId	string	The name of the AD user who uses the virtual MFA device.	usertest
ConsecutiveFails	integer	The number of consecutive failures to bind the virtual MFA device, or the number of failures on the verification of the virtual MFA device.	1
OfficeSiteId	string	The ID of the workspace.	cn-hangzhou+dir-269345****
status	string	The status of the virtual MFA device. Valid values: LOCKED UNBOUND NORMAL	NORMAL
DirectoryId	string	Note This parameter is in invitational preview and is not publicly available.	cn-hangzhou+dir-gx2x1dhsmu52rd****
GmtEnabled	string	The time when the virtual MFA device was started. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2020-12-20T14:52:28Z

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-06-07	The request parameters of the API has changed	View Change Details