All Products
Search
Document Center

Resource Access Management:CreateVirtualMFADevice

Last Updated:Aug 09, 2024

Creates a multi-factor authentication (MFA) device.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ram:CreateVirtualMFADevicecreate
  • MFADevice
    acs:ram:*:{#accountId}:mfa/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VirtualMFADeviceNamestringYes

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 parameters

ParameterTypeDescriptionExample
object
VirtualMFADeviceobject

The information of the MFA device.

SerialNumberstring

The serial number of the MFA device.

acs:ram::123456789012****:mfa/device001
QRCodePNGstring

The Base64-encoded QR code, in the PNG format.

YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****
Base32StringSeedstring

The key of the MFA device.

DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGS****
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history