6 Login endpoints
j21marbr edited this page 2026-05-27 14:48:23 +00:00

Login endpoints

GET /health

Path to endpoint

GET /health

Return values

Returns a status message.

When no error occurs

  • Service is running
  • Status: 200 OK

POST /auth/Login

Path to endpoint

POST /auth/Login

Required values

  • Username: username
  • Password: password

Return values

Returns a JSON object containing authentication response data:

  • IsSuccess: success message
  • ErrorMessage: error message

When no error occurs

  • User is logged in successfully
  • Status: 200 OK

When error occurs

  • Login failed or invalid login data
  • Status: 400 Bad Request

POST /auth/SignUp

Path to endpoint

POST /auth/SignUp

Required values

  • Username: username
  • Firstname: first name
  • Lastname: last name
  • Email: email address
  • Password: password

Return values

Returns a JSON object containing authentication response data:

  • IsSuccess: success message
  • ErrorMessage: error message

When no error occurs

  • User is signed up successfully
  • Status: 200 OK

When error occurs

  • Sign up failed or invalid sign up data
  • Status: 400 Bad Request

POST /auth/ChangePassword

Path to endpoint

POST /auth/ChangePassword

Required values

  • Username: username
  • OldPassword: old password
  • NewPassword: new password

Return values

Returns a JSON object containing authentication response data:

  • IsSuccess: success message
  • ErrorMessage: error message

When no error occurs

  • Password is changed successfully
  • Status: 200 OK

When error occurs

  • Password change failed or invalid password data
  • Status: 400 Bad Request

POST /auth/Refresh

Path to endpoint

POST /auth/Refresh

Return values

Refreshes the authentication tokens.

When no error occurs

  • New access token is created
  • New refresh token is created
  • Status: 200 OK

When error occurs

  • Refresh failed or invalid refresh token
  • Status: 401 Unauthorized

POST /auth/Logout

Path to endpoint

POST /auth/Logout

Return values

Logs out the authenticated user.

When no error occurs

  • User is logged out successfully
  • Authentication cookies are deleted
  • Status: 200 OK

When error occurs

  • Invalid or missing refresh token
  • Status: 401 Unauthorized

DELETE /auth/DeleteAccount

Path to endpoint

DELETE /auth/DeleteAccount

Required values

  • Username: username
  • Password: password

Return values

Returns a JSON object containing authentication response data:

  • IsSuccess: success message
  • ErrorMessage: error message

When no error occurs

  • User account is deleted successfully
  • Status: 200 OK

When error occurs

  • Delete account failed or invalid account data
  • Status: 400 Bad Request