Disabling a Virtual MFA Device

Function

This API is used to disable a specified virtual MFA device and disassociate it from the corresponding 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:disableV5	Write	mfa *	-	-	-

URI

POST /v5/mfa-devices/disable

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

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

Disabling the virtual MFA device whose serial number is iam::accountid:mfa:name and disassociating it from IAM user xxx

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

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

Example Responses

None

Status Codes

Status Code	Description
200	Successful
400	Bad request
403	Forbidden
404	Not found

Error Codes

See Error Codes.

Parent topic: Managing MFA Devices

Previous topic: Enabling a Virtual MFA Device

Next topic: Creating a Virtual MFA Device

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot