From Bright Pattern Documentation
Jump to: navigation, search
(Get User Lock State)
 
 
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.
  
== URL ==
+
== Request ==
http[s]://<host>:<port>/admin/ws/t/<tenant_url>/user/lock/<login_id>
+
=== URL ===
 +
http[s]://<host>/admin/ws/t/<tenant_url>/user/lock/<login_id>
  
== Method ==
+
=== HTTP Method ===
 
GET
 
GET
  
 
== Response ==
 
== Response ==
{|border="1" style="border-collapse:collapse" cellpadding="5"
+
{
|
+
    "lockedOut":true
{
+
}
  "lockedOut":true
+
 
}
 
|}
 
  
  
  
 
</translate>
 
</translate>

Latest revision as of 23:44, 13 November 2018

• 3.16 • 3.17 • 3.18

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>/admin/ws/t/<tenant_url>/user/lock/<login_id>

HTTP Method

GET

Response

{
   "lockedOut":true
}


< Previous | Next >