Modifying the Login Protection Configuration of a User¶
Function¶
This API is provided for the administrator to modify the login protection configuration of a user.
URI¶
PUT /v3.0/OS-USER/users/{user_id}/login-protect
Parameter | Mandatory | Type | Description |
---|---|---|---|
user_id | Yes | String | ID of the user whose login protection configuration is to be modified. |
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. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
enabled | Yes | Boolean | Indicates whether login protection has been enabled for the user. The value can be true or false. |
verification_method | Yes | String | Login authentication method of the user. Options: sms, email, and vmfa. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
object | Login protection configuration. |
Parameter | Type | Description |
---|---|---|
user_id | String | User ID. |
enabled | Boolean | Indicates whether login protection has been enabled for the user. The value can be true or false. |
verification_method | String | Login authentication method of the user. Options: sms, email, and vmfa. |
Example Request¶
PUT https://sample.domain.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. |