Help Center/ Identity and Access Management/ API Reference/ API/ Security Settings/ Querying the Login Protection Configuration of an IAM User
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Querying the Login Protection Configuration of an IAM User

Function

This API can be used by the administrator to query the login protection configuration of a specified IAM user or used by an IAM user to query their own login protection configuration.

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

Debugging

You can debug this API in API Explorer.

URI

GET /v3.0/OS-USER/users/{user_id}/login-protect

Table 1 URI parameters

Parameter

Mandatory

Type

Description

user_id

Yes

String

IAM user ID. For details about how to obtain a user ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

If the administrator is requesting to query the login protection configuration of a specified user, see Actions.

If an IAM user is requesting to query their own login protection configuration, the user token (no special permission requirements) of the user is required.

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

login_protect

object

Login protection configuration.
Table 4 login_protect

Parameter

Type

Description

enabled

Boolean

Indicates whether login protection has been enabled for an IAM user. The value can be true or false.

user_id

String

IAM user ID.

verification_method

String

Login authentication method of the IAM user.

Example Request

Request for querying the login protection configuration of an IAM user

GET https://iam.myhuaweicloud.com/v3.0/OS-USER/users/{user_id}/login-protect

Example Response

Status code: 200

The request is successful.

{ 
  "login_protect" : { 
    "user_id" : "16b26081f43d4c628c4bb88cf32e9...", 
    "enabled" : true, 
    "verification_method" : "vmfa" 
  } 
}

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" 
}

This API cannot be used to obtain the login protection configurations of users for whom login protection is disabled, and will return the 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