Deleting a Virtual MFA Device
Function
This API is used to delete a virtual MFA device.
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:deleteVirtualMFADeviceV5 | Write | mfa * | - | - | - |
URI
DELETE /v5/virtual-mfa-devices
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| user_id | Yes | String | Definition: IAM user ID, which is automatically generated when the IAM user is created. Constraints: N/A 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 |
Request Parameters
None
Response Parameters
Status code: 204
Successful
Status code: 400
| 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
| 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
| 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
Deleting the virtual MFA device whose serial number is iam::accountid:mfa:name for IAM user xxx
DELETE https://{endpoint}/v5/virtual-mfa-devices?user_id=xxx&serial_number=iam%3A%3Aaccountid%3Amfa%3Aname Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 204 | Successful |
| 400 | Bad request |
| 403 | Forbidden |
| 404 | Not found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot