Use the CreateVirtualMFADevice API to create a virtual MFA device - Resource Access Management - Alibaba Cloud - Resource Access Management

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

ram:CreateVirtualMFADevice

create

*MFADevice

acs:ram:*:{#accountId}:mfa/*

None

Request parameters

Parameter	Type	Required	Description	Example
VirtualMFADeviceName	string	No	The name of the MFA device. The name must be 1 to 64 characters in length, and can contain letters, digits, periods (.), and hyphens (-).	device001

Response elements

Element	Type	Description	Example
	object	The response parameters.
VirtualMFADevice	object	The information about the MFA device.
SerialNumber	string	The serial number of the MFA device.	acs:ram::123456789012****:mfa/device001
QRCodePNG	string	The Base64-encoded QR code, in the PNG format.	YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****
Base32StringSeed	string	The key of the MFA device.	DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGS****
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "VirtualMFADevice": {
    "SerialNumber": "acs:ram::123456789012****:mfa/device001",
    "QRCodePNG": "YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****",
    "Base32StringSeed": "DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGS****"
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error response

JSON format

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "VirtualMFADevice": {
        "SerialNumber": "acs:ram::1234567890123:mfa/device001",
        "Base32StringSeed": "DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGSD7A8",
        "QRCodePNG": "YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEzdCAg"
    }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.