From Bright Pattern Documentation
(Updated via BpDeleteTranslateTags script) |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = Get User Lock State= | |
Checks whether 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. | ||
| 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 === | ||
GET | GET | ||
| + | |||
| + | === Content-Type === | ||
| + | application/json | ||
== 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 | ||
| + | |} | ||
| + | |||
| + | === Example Response === | ||
| + | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"lockedOut":true | "lockedOut":true | ||
} | } | ||
| − | + | </syntaxhighlight> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | </ | ||
Latest revision as of 04:32, 29 May 2024
• 5.2
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
Content-Type
application/json
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 |
Example Response
{
"lockedOut":true
}