All Products
Search

This Product

    Elastic Desktop Service:DescribeVirtualMFADevices

    Document Center

    Elastic Desktop Service:DescribeVirtualMFADevices

    Last Updated:May 12, 2026

    Retrieves the virtual multi-factor authentication (MFA) device associated with an Active Directory (AD) account.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ecd:DescribeVirtualMFADevices

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. Call the DescribeRegions operation to query the regions supported by Elastic Desktop Service (EDS).

    cn-hangzhou
    MaxResults

    integer

    No

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

    100
    NextToken

    string

    No

    The pagination token. If a response is truncated, use the returned NextToken to retrieve the next page of results.

    caeba0bbb2be03f84eb48b699f0a4883
    OfficeSiteId

    string

    No

    The office network ID.

    cn-hangzhou+dir-269345****
    EndUserId

    array

    No

    The list of Active Directory (AD) account usernames.

    testuser

    string

    No

    An Active Directory (AD) account username.

    testuser
    Filter

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    NextToken

    string

    The token to retrieve the next page of results. If this parameter is empty, no more results are available.

    AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as
    RequestId

    string

    The request ID.

    FB550AAB-FB36-4A91-93F6-F4374AF65403
    VirtualMFADevices

    array<object>

    A list of virtual MFA devices.

    array<object>

    Details of a virtual MFA device.

    SerialNumber

    string

    The serial number of the virtual MFA device.

    a25f297f-f2e1-4a44-bbf1-5f48a6e5****
    GmtUnlock

    string

    The time when the locked virtual MFA device is automatically unlocked. The time is in the YYYY-MM-DDThh:mm:ssZ format and in UTC, as specified by the ISO 8601 standard.

    2020-12-21T15:21:28Z
    EndUserId

    string

    The AD username of the bound user.

    usertest
    ConsecutiveFails

    integer

    The number of consecutive failed attempts to bind or authenticate the virtual MFA device.

    1
    OfficeSiteId

    string

    The workspace ID.

    cn-hangzhou+dir-269345****
    status

    string

    The status of the virtual MFA device.

    Valid values:

    • LOCKED :

      locked

    • UNBOUND :

      unbound

    • NORMAL :

      normal

    NORMAL
    DirectoryId

    string
    Note

    This parameter is in private preview.

    cn-hangzhou+dir-gx2x1dhsmu52rd****
    GmtEnabled

    string

    The time when the virtual MFA device was enabled. The time is in the YYYY-MM-DDThh:mm:ssZ format and in UTC, as specified by the ISO 8601 standard.

    2020-12-20T14:52:28Z
    AdUser

    object

    EndUser

    string

    DisplayName

    string

    DisplayNameNew

    string

    UserPrincipalName

    string

    Examples

    Success response

    JSON format

    {
  "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",
      "AdUser": {
        "EndUser": "",
        "DisplayName": "",
        "DisplayNameNew": "",
        "UserPrincipalName": ""
      }
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.