Skip to content

Latest commit

 

History

History
50 lines (45 loc) · 1.01 KB

File metadata and controls

50 lines (45 loc) · 1.01 KB

Login API

  • URL path: /auth/login
  • method: post

body payload example

{"usernameOrEmail": "required string", "password": "required string", "rememeberMe": "optional bool"}

status 200 response

{
    "success": true,
    "code": 200,
    "result": {
        "role": "USER",
        "status": "ACTIVE",
        "fName": "first name",
        "lName": "last name",
        "email": "emailaddress@gmail.com",
        "username": "username",
        "locale": "en_US",
        "createdAt": "2022-04-26 17:12:54",
        "updatedAt": "2022-06-01 17:07:08",
        "deletedAt": null
    }
}

status 400 response structure

{
    "success": false,
    "code": 400,
    "errors": "invalid_username_or_password"
}

status 400 response messages

  • Username_or_email_is_required
  • password_is_required
  • user_not_found
  • invalid_username_or_password
  • account_banned
  • account_inactive
  • unable_to_authenticate
  • Maximun_devices_logged
  • unable_to_create_OTP_session
  • otp_validation_required