Available in API 2.11+
Authenticate against an existing MIDAS user account.
Note: "authenticate_user" API calls respect the "Max Invalid Login Attempts" security setting.
Tip: For increased security, we strongly advise that "authenticate_user" API calls are only made using http POST methods (and not http GET methods)
|Required Parameters||Possible Values||Description|
|email||Email Address||Email address of account to authenticate|
|pw||String||Corresponding password for account to authenticate|
|Optional Parameters||Possible Values||Description|
|bypass_fail_count||0 | 1||If set to 1, the API will bypass the previously failed login count checking & incrementing. If omitted, or explicitly set to 0, each failed authentication attempt via the API will count towards a failed login attempt against the user account. After too many failed login attempts, user accounts are automatically locked. This threshold may be set within the software via MIDAS Admin Options → Manage MIDAS → Security|
|include_locked||0 | 1||If set to 1 the API will be allowed to authenticate accounts even if user account is locked/suspended. If omitted, or explicitly set to 0, authentication will fail for user accounts which are currently locked/suspended|
|authenticated||Returns "1" if supplied email address and corresponding password are valid, otherwise returns "0"|
|id||If the returned "authenticated" response is "1", the "id" parameter contains the internal user ID of the authenticated account|