Management::UserManagement::is_locked_out

Introduced : BIG-IP_v10.2.0
Checks to see if a user is locked out due to exceeding the maximum number of allowed login failures. Return whether the user is locked out.

Prototype

boolean [] is_locked_out(
    in String [] user_names
);

Parameters

Parameter Type Description
user_names String [] The user names.

Return Type

Type Description
boolean [] The lockout status for each user.

Exceptions

Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::OperationFailed Raised if an operation error occurs.
Common::InvalidArgument Raised if one of the arguments is invalid.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.