Search User Login Lockouts

Version 4.0.24.6 (latest)

Search currently locked-out users.

Request

GET /user_login_lockouts/search
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
fields
string
Include only these fields in the response
page
integer
DEPRECATED. Use limit and offset instead. Return only page N of paginated results
per_page
integer
DEPRECATED. Use limit and offset instead. Return N rows of data per page
limit
integer
Number of results to return. (used with offset and takes priority over page and per_page)
offset
integer
Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
sorts
string
Fields to sort by.
auth_type
string
Auth type user is locked out for (email, ldap, totp, api)
full_name
string
Match name
email
string
Match email
remote_id
string
Match remote LDAP ID
filter_or
boolean
Combine given search criteria in a boolean OR expression

Response

200: User Login Lockout

Datatype
Description
(array)
can
object
Operations the current user is able to perform on this object
key
string
Hash of user's client id
auth_type
string
Authentication method for login failures
ip
string
IP address of most recent failed attempt
user_id
string
User ID
remote_id
string
Remote ID of user if using LDAP
full_name
string
User's name
email
string
Email address associated with the user's account
fail_count
integer
Number of failures that triggered the lockout
lockout_at
string
Time when lockout was triggered

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link