[Feature-API] account_password_management: Verify Account and Password

[Xiao75896453]

What problem does this feature solve?

Inputs:

A JSON payload containing the following fields:

• "username": a string representing the username of the account being accessed.
• "password": a string representing the password being used to access the account.

Output:

Returns a JSON payload containing the following field:

• "success": a boolean field indicating the validity of the password provided for the given username, with "true" indicating that the password is correct and "false" indicating otherwise.
• "reason": a string field indicating the reason if needed.

If the password verification fails five times, the user should wait one minute before attempting to verify the password again. The API should return the appropriate HTTP status code and message to indicate this situation.

What does the proposed feature look like?

Request

• method: POST
• endpoint: authentications/verifications

Parameters: (Name, Data Type, How to Get)

Request Body

{
  "username": str
  "password": str
}

Reponse

{
  "success": bool
  "reason": str | None
}

Success Example

{
  "success": True
  "reason": None
}

Fail: (Situation, HTTP Status Code)

• Password is not correct : 401
• Too many failed verification attempts : 401
• Username not exists : 404