Modifying the Login Protection Configuration of an IAM User
Function
This API is provided for the administrator to modify the login protection configuration of an IAM user.
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
PUT /v3.0/OS-USER/users/{user_id}/login-protect
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user_id |
Yes |
String |
ID of the IAM user whose login protection configuration is to be modified. For details about how to obtain a user ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-token |
Yes |
String |
Token with Security Administrator permissions. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Yes |
object |
Login protection configuration. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
object |
Login protection configuration. |
Parameter |
Type |
Description |
---|---|---|
user_id |
String |
ID of the user whose login protection configuration is to be modified. |
enabled |
Boolean |
Whether login protection has been enabled for the user. The value can be true or false. |
verification_method |
String |
Login authentication method of the IAM user. Options: sms, email, and vmfa. |
Example Request
Request for enabling login protection and setting the login authentication method to MFA authentication
PUT https://iam.myhuaweicloud.com/v3.0/OS-USER/users/{user_id}/login-protect
{
"login_protect" : {
"enabled" : true,
"verification_method" : "vmfa"
}
}
Example Response
Status code: 200
The request is successful.
{ "login_protect" : { "user_id": "16b26081f43d4c628c4bb88cf32e9...", "enabled" : true, "verification_method" : "vmfa" } }
Status Codes
Status Code |
Description |
---|---|
200 |
The request is successful. |
400 |
The request is invalid. |
401 |
Authentication failed. |
403 |
You do not have permission to perform this action. |
404 |
The requested resource cannot be found. |
500 |
A system error occurred. |
Error Codes
For details, 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