From Bright Pattern Documentation
Jump to: navigation, search
 
Line 1: Line 1:
 
<translate>= Get User Lock State=
 
<translate>= Get User Lock State=
This API is used to check if a user's account has been temporarily locked out after too many invalid login attempts.
+
Checks whether a user's account has been temporarily locked out after too many invalid login attempts.
  
 +
== Request ==
 +
=== URL ===
 +
http[s]://<host>/configapi/v2/user/lock/<login_id>
  
== URL ==
+
=== HTTP Method ===
http[s]://<host>:<port>/configapi/v2/user/lock/<login_id>
 
 
 
== Method ==
 
 
GET
 
GET
  
 
== Response ==
 
== Response ==
{  
+
  {  
  "lockedOut":true
+
    "lockedOut":true
}  
+
  }  
 +
 
  
  
  
  
<center>[[user-management-api-specification/UpdateUser|< Previous]]  |  [[user-management-api-specification/ClearUserLockState|Next >]]</center>
 
 
</translate>
 
</translate>

Revision as of 23:46, 13 November 2018

• 5.2

<translate>= Get User Lock State= Checks whether a user's account has been temporarily locked out after too many invalid login attempts.

Request

URL

http[s]://<host>/configapi/v2/user/lock/<login_id>

HTTP Method

GET

Response

 { 
   "lockedOut":true
 } 



</translate>

< Previous | Next >