Provide users with the ability to securely log in to the application and make authenticated requests to the API.
User Stories
As a user, I want to securely login to the app using my email/username and password.
As a user, I want my login session to persist across app closures and restarts.
As a user, I want to securely logout from the app, ending my current session.
Acceptance Criteria
User can enter their email/username and password into a form.
Upon form submission, the app will make a POST request to the /login endpoint with the login payload.
User can logout from the app which will invalidate their current session.
Required API Fields
Request
username_or_email: String
password: String
Response
jwt: String (The authentication token)
Out of Scope
Account creation/registration
Password recovery
Two-Factor Authentication (TOTP)
Further Details
Upon successful login, the server will respond with a JWT token. This token should be included as an 'auth' parameter in the query string for all subsequent authenticated requests. The format of the parameter should be ?auth={token} where {token} is replaced with the actual JWT token received.
Objective
Provide users with the ability to securely log in to the application and make authenticated requests to the API.
User Stories
Acceptance Criteria
/loginendpoint with the login payload.Required API Fields
Request
username_or_email: Stringpassword: StringResponse
jwt: String (The authentication token)Out of Scope
Further Details
Upon successful login, the server will respond with a JWT token. This token should be included as an 'auth' parameter in the query string for all subsequent authenticated requests. The format of the parameter should be
?auth={token}where{token}is replaced with the actual JWT token received.