API Reference

Auth Routes

• POST /v1/user/register - Register a user

  Request Body

  {
      first_name : string;
      last_name : string;
      email : string;
      password : string;
  }

  Response Codes

  • 400 - Validation Error
  • 409 - Email / User already exists
  • 200 - User created successfully

• POST /v1/user/login - Login a user

  Request Body

  {
      email : string;
      password : string
  }

  Response Codes

  • 400 - Email and password is required
  • 403 - Email is associated with social login
  • 401 - Incorrect email or password
  • 200 - User logged in successfully

• GET /v1/user/login - Check if user is logged in.

  Response Codes

  • 401 - Not logged in
  • 200 - User is logged in

• POST /v1/user/logout - Logout the current user

• GET /v1/auth/google - Login with google

• GET /v1/auth/facebook - Login with facebook

Developer Notes

• protected - protected is a thunk function which returns a protected middleware. This is used to protect routes and give access to logged in users and users with specified roles.

  Arguments

  roles?: ["USER", "ADMIN"] 
  

  Response Codes 401 - Not Logged In , User does not exist , Doesn't have permission

  Example:-

  // Only looks if user is logged in
  app.get("/v1/loginprotected", protect(), (_, res) => {
      res.status(200).json({ status: "success" });
  });
  
  // Looks if user is logged in and has specified roles in this case "ADMIN"
  app.get("/v1/roleprotected", protect(["ADMIN"]), (_, res) => {
      res.status(200).json({ status: "success" });
  });

• OAuth Client redirect url and path

  Set FRONTEND_CLIENT env variable to frontend clients host url

  Set SUCCESS_ROUTE env variable to path to which the user should be redirected on OAuth success.

  Set FAILURE_ROUTE env variable to path to which user should be redirected on OAuth failure.

ER Diagram