MobileApp
Login
Function: login Type: API Endpoint (GET)
Purpose:
This function verifies the user's credentials and returns a JSON response indicating whether the login was successful or not.
URL:
GET http://<baseURL>/api/MobileApp/login
Request Headers:
- Username (Header, required):
The email address of the user to log in. - Password (Header, required):
The password of the user to log in.
Response:
A JSON response containing the status of the login attempt.
If the login is successful, the response will contain a "status" key with the value "success" and either an "mfa" or "message" key depending on whether MFA is enabled or not.
If the login fails, the response will contain a "status" key with the value "failed" and a "message" key with the error message.
Error Handling:
- Raises HTTP 401 if the email or password is incorrect.
- Raises HTTP 500 for any other exceptions encountered during execution.
get/api/MobileApp/login
Request
- Base URLhttps://api.leapsurgebi.com (the document declares no server; this is the origin it was published from)
- AuthOAuth 2PasswordToken URL/auth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Usernamestring required
Passwordstring required
Response
Successful Response
unknown required
Changes
No recorded changes to this operation across all 3 revisions of this API.