Querying the Login Protection Configuration of a User
Function
This API can be used by the administrator to query the login protection configuration of a specified user or used by a user to query their login protection configuration.
URI
GET /v3.0/OS-USER/users/{user_id}/login-protect
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user_id |
Yes |
String |
User ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
A token with Security Administrator permissions is required if the administrator is requesting to query the login protection configuration of a specified user. If a user is requesting to query their login protection configuration, the user token (no special permission requirements) of the user is required. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
object |
Login protection configuration. |
Example Request
GET https://sample.domain.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" }
If login protection has never been configured for a user, you cannot use this API to obtain the login protection configuration of the user. Otherwise, the error code IAM.0004 will be returned.
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. |
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