From Bright Pattern Documentation
| Line 5: | Line 5: | ||
=== URL === | === URL === | ||
http[s]://<host>/configapi/v2/user/lock/<login_id> | http[s]://<host>/configapi/v2/user/lock/<login_id> | ||
| + | |||
| + | For example: | ||
| + | http://example.com/configapi/v2/user/lock/lisa.simpson | ||
=== HTTP Method === | === HTTP Method === | ||
| Line 10: | Line 13: | ||
== Response == | == Response == | ||
| + | In response to a successful request, the user's ''lockedOut'' status is provided in JSON. | ||
| + | |||
| + | === Parameters === | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameter''' | ||
| + | | '''Data-Type''' | ||
| + | | '''Description''' | ||
| + | | '''Example''' | ||
| + | |- | ||
| + | | lockedOut | ||
| + | | Boolean | ||
| + | | Whether the user is locked out ("true") or not ("false") | ||
| + | | true | ||
| + | |} | ||
| + | |||
| + | === Response Example === | ||
{ | { | ||
"lockedOut":true | "lockedOut":true | ||
Revision as of 18:20, 12 March 2019
• 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>
For example:
http://example.com/configapi/v2/user/lock/lisa.simpson
HTTP Method
GET
Response
In response to a successful request, the user's lockedOut status is provided in JSON.
Parameters
| Parameter | Data-Type | Description | Example |
| lockedOut | Boolean | Whether the user is locked out ("true") or not ("false") | true |
Response Example
{
"lockedOut":true
}
</translate>