Table of Contents
- API Usage Guide
- API Command Reference
- add_booking
- add_client
- add_invoice
- add_resource
- approve_request
- authenticate_user
- del_booking
- del_bookings
- del_client
- del_invoice
- del_resource
- email_client
- gen_invoice
- get_activity
- get_availability
- get_booking
- get_booking_type
- get_booking_types
- get_bookings
- get_client
- get_consumable_levels
- get_invoice
- get_invoices
- get_messages
- get_reminders
- get_resource
- get_resource_availability
- get_setting
- get_template
- get_user
- get_users_logged_in
- get_venue
- get_venues
- get_venues_in_group
- get_venues_in_use
- get_watches
- mod_booking
- mod_client
- mod_invoice
- mod_resource
- mod_venue
- notify_user
- reject_request
- restore_booking
- set_setting
- set_template
- util_api_usage
- util_from_epoch
- util_to_epoch
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Troubleshooting
- Release Notes
← Hide Table of Contents
MIDAS API: authenticate_user
MIDAS API: authenticate_userAvailable 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 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 |
| Example Response |
{
"authenticated":"1",
"id":"4"
} |
| Variables Returned | Description |
| 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 |