diff --git a/doc/auth/2fa.md b/doc/auth/2fa.md index e69de29..ef087b4 100644 --- a/doc/auth/2fa.md +++ b/doc/auth/2fa.md @@ -0,0 +1,68 @@ +# 2fa + +Abailable endpoints: +- POST `/2fa` +- POST `/2fa/verify` +- DELETE `/2fa` + +Common return: +- 500 with response +```json +{ + "error": "Internal server error" +} +``` + +## POST `/2fa` + +Used to enable 2fa (need to verify after to confirm) + +Inputs: just need a valid JWT cookie + +Returns: +- 200 +```json +{ + "secret": "" + "otpauthUrl": "" +} +``` + +## POST `/2fa/verify` + +Used to confirm 2fa + +Inputs: a valid JWT in cookie and +```json +{ + "token": "" +} +``` + +Returns: +- 200 +```json +{ + "msg": "2FA verified successfully" +} +``` +- 401 || 400 || 404 +```json +{ + "error": "" +} +``` + +## DELETE `/2fa` + +Used to remove 2fa + +Inputs: a valid JWT in cookie + +Returns: +- 200 +```json +{ + "msg": "TOTP removed" +} +``` diff --git a/doc/auth/login.md b/doc/auth/login.md index 53f65cc..76945d3 100644 --- a/doc/auth/login.md +++ b/doc/auth/login.md @@ -1,6 +1,65 @@ # Login Abailable endpoints: -- `/login` -- `/login/google` -- `/login/google/callback` +- POST `/login` +- GET `/login/google` +- GET `/login/google/callback` + +Common return: +- 500 with response +```json +{ + "error": "Internal server error" +} +``` + +## POST `/login` + +Used to login + +Input needed : +```json +{ + "user": "", + "password": "" +} +``` + +Can return: +- 200 with response and cookie in header +```json +{ + "msg": "Login successfully" +} +``` +- 400 with response +```json +{ + "error": "" +} +``` + +## GET `/login/google` + +Used to redirect the user to the login page for google auth + +Always return: +- redirect to the google auth url + +## GET `/login/google/callback` + +Used to get the callback from google and confirm the login + +Can return: +- 400 with response +```json +{ + "error": "" +} +``` +- 200 with response and cookie in header +```json +{ + "msg": "Login successfully" +} +``` diff --git a/doc/auth/me.md b/doc/auth/me.md new file mode 100644 index 0000000..4c907e2 --- /dev/null +++ b/doc/auth/me.md @@ -0,0 +1,5 @@ +GET `/me` + +Inputs : just need the JWT cookie + +Returns the user of the account diff --git a/doc/auth/register.md b/doc/auth/register.md index eaabc43..55caca5 100644 --- a/doc/auth/register.md +++ b/doc/auth/register.md @@ -1,9 +1,9 @@ # Register Available endpoints: -- `/register` -- `/register/google` -- `/register/google/callback` +- POST `/register` +- GET `/register/google` +- GET `/register/google/callback` Common return: - 500 with response @@ -13,7 +13,9 @@ Common return: } ``` -## `/register` +## POST `/register` + +Used to register Input needed : ```json @@ -37,16 +39,27 @@ Can return: } ``` -## `/register/google` +## GET `/register/google` -Does not take input +Used to redirect to the google auth page Always return: - redirect to the google auth url -## `/register/google/callback` +## GET `/register/google/callback` -inputs are filled by google +Used to get the callback from google and register Can return: - 400 with response +```json +{ + "error": "" +} +``` +- 200 with response and cookie in header +```json +{ + "msg": "Register successfully" +} +```