Enabling a Virtual MFA Device

Function

This API is used to enable a specified virtual MFA device and associate it with a specified IAM user.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam:mfa:enableV5	Write	mfa *	-	-	-

URI

POST /v5/mfa-devices/enable

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	IAM user ID.
serial_number	Yes	String	Serial number of a virtual MFA device. Maximum: 150
authentication_code_first	Yes	String	Verification code sent by a device. Maximum: 12
authentication_code_second	Yes	String	Subsequent verification code sent by a device. Maximum: 12

Response Parameters

Status code: 200

Successful

Status code: 400

**Table 2** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Status code: 404

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Requests

Enabling the virtual MFA device whose serial number is iam::accountid:mfa:name and associating it with IAM user xxx

POST https://{endpoint}/v5/mfa-devices/enable

{
  "user_id" : "xxx",
  "serial_number" : "iam::accountid:mfa:name",
  "authentication_code_first" : "123456",
  "authentication_code_second" : "123456"
}