Help Center> Identity and Access Management> API Reference> API> Security Settings> Querying MFA Device Information of IAM Users
Updated on 2023-07-05 GMT+08:00
View PDF

Querying MFA Device Information of IAM Users

Function

This API is provided for the administrator to query the MFA device information of IAM users.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

URI

GET /v3.0/OS-MFA/virtual-mfa-devices

Request Parameters

Table 1 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Access token issued to a user to bear its identity and permissions.

For details about the permissions required by the token, see Actions.

Response Parameters

Table 2 Parameters in the response body

Parameter

Type

Description

virtual_mfa_devices

Array of objects

Virtual MFA device information.
Table 3 virtual_mfa_devices

Parameter

Type

Description

serial_number

String

Virtual MFA device serial number.

user_id

String

IAM user ID.

Example Request

Request for querying MFA device information of IAM users

GET https://iam.myhuaweicloud.com/v3.0/OS-MFA/virtual-mfa-devices

Example Response

Status code: 200

The request is successful.

{ 
  "virtual_mfa_devices" : [ 
          { 
              "user_id" : "16b26081f43d4c628c4bb88cf32e9...", 
              "serial_number" : "iam/mfa/16b26081f43d4c628c4bb88cf32e9..." 
            }, 
           { 
              "user_id" : "47026081f43d4c628c4bb88cf32e9...", 
              "serial_number" : "iam/mfa/75226081f43d4c628c4bb88cf32e9..." 
             } 
          ] 
}

Status code: 403

Access denied.

  • Example 1
{ 
   "error_msg" : "You are not authorized to perform the requested action.", 
   "error_code" : "IAM.0002" 
 }
  • Example 2
{ 
   "error_msg" : "Policy doesn't allow %(actions)s to be performed.", 
   "error_code" : "IAM.0003" 
 }

Status code: 404

The requested resource cannot be found.

{ 
  "error_msg" : "Could not find %(target)s: %(target_id)s.", 
  "error_code" : "IAM.0004" 
}

Status code: 500

Internal server error.

{ 
  "error_msg" : "An unexpected error prevented the server from fulfilling your request.", 
  "error_code" : "IAM.0006" 
}

Status Codes

Status Code

Description

200

The request is successful.

401

Authentication failed.

403

Access denied.

404

The requested resource cannot be found.

500

Internal server error.

Error Codes

For details, see Error Codes.

Parent topic: Security Settings