Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ Managing MFA Devices/ Disabling a Virtual MFA Device
Updated on 2026-07-22 GMT+08:00
View PDF
Share

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 root user 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

Definition:

IAM user ID, which is globally unique.

Constraints:

Character string type. It is a standard IAM user ID generated by the platform.

Range:

N/A

Default Value:

N/A

serial_number

Yes

String

Definition:

Serial number of the MFA device, which is automatically generated when the MFA device is created.

Constraints:

The value contains 0 to 150 characters.

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Successful

Status code: 400

Table 2 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

Status code: 403

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

encoded_authorization_message

String

Definition :

Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link.

Range:

N/A.

Status code: 404

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

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