• 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
  }

< Previous | Next >