Forgot password
Used to reset a password for the user.
#
Send forgot password emailURL: /api/auth/forgotPassword/sendEmail
Method: POST
Auth required: No
Data constraints
Data example
#
Success responseCondition: Username exists and user has email adresses linked to his account.
Code: 200
Content example
#
Error response#
Unknown usernameCondition: User with this username does not exist
Code: 404
Content example
#
No email address(es) linked to this accountCondition: User does not have email address(es) linked to his account.
Code: 400
Content example
#
Check codeURL: /api/auth/forgotPassword/checkCode
Method: POST
Auth required: No
Data constraints
Data example
#
Success responseCondition: Code is correct, rate limit not exceeded, username exists
Code: 200
Content example
#
Error response#
Incorrect codeCondition: Code is incorrect
Code: 400
Content example
#
Unknown usernameCondition: User with this username does not exist
Code: 404
Content example
#
Rate limit exceededCondition: After 12 tries the rate limit will be exceeded.
Code: 400
Content example
After exceeding the rate limit there has to be requested a new code via this request.
#
No password reset requested for this userCondition: There was not requested a password reset for this account
Code: 400
Content example
#
Reset passwordURL: /api/auth/forgotPassword/resetPassword
Method: POST
Auth required: No
Data constraints
Data example
#
Success responseCondition: Code is correct, rate limit not exceeded, username exists
Code: 200
Content example
#
Error response#
Incorrect codeCondition: Code is incorrect
Code: 400
Content example
#
Unknown usernameCondition: User with this username does not exist
Code: 404
Content example
#
Rate limit exceededCondition: After 12 tries the rate limit will be exceeded.
Code: 400
Content example
After exceeding the rate limit there has to be requested a new code via this request.
#
No password reset requested for this userCondition: There was not requested a password reset for this account
Code: 400
Content example