freeipa/doc/api/user_status.md
Antonio Torres 988cb5a535 doc: generate API Reference
Extend the 'make api' target so that we also build an API Reference in
Markdown format. One template for each command gets generated. These
templates include all of the command details (arguments, options and
outputs), and then a section for manually-added notes such as semantics
or version differences. Every time the docs are regenerated, these notes
will be added if they exist.

Signed-off-by: Antonio Torres <antorres@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
2022-11-16 14:46:17 -05:00

1.4 KiB

user_status

Lockout status of a user account

An account may become locked if the password is entered incorrectly too many times within a specific time period as controlled by password policy. A locked account is a temporary condition and may be unlocked by an administrator.

This connects to each IPA master and displays the lockout status on each one.

To determine whether an account is locked on a given server you need to compare the number of failed logins and the time of the last failure. For an account to be locked it must exceed the maxfail failures within the failinterval duration as specified in the password policy associated with the user.

The failed login counter is modified only when a user attempts a log in so it is possible that an account may appear locked but the last failed login attempt is older than the lockouttime of the password policy. This means that the user may attempt a login again.

Arguments

Name Type Required
useruid :ref:Str<Str> True

Options

  • all : :ref:Flag<Flag> (Required)
  • Default: False
  • raw : :ref:Flag<Flag> (Required)
  • Default: False
  • version : :ref:Str<Str>

Output

Name Type
count Output
result ListOfEntries
summary Output
truncated Output

Semantics

Notes

Version differences