{"info":{"_postman_id":"3b309b81-f0f0-4e84-87e4-b6192d35cd61","name":"2FA App","description":"

Project Description:

\n

This Postman collection provides a set of API endpoints for user authentication and management using MongoDB as the database and OTPAuth for generating and validating One-Time Passwords (OTP). The collection includes routes for user registration, login, OTP generation, verification, validation, and disabling.

\n

The collection utilizes the Express.js framework for building the API endpoints and the OTPAuth library for handling the generation and validation of OTPs. The backend is built to work with a MongoDB database to store user information and OTP-related data.

\n

NOTE: Authentication(Login and Registration Not fully implemented, emphasis is on the 2FA)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22824646","collectionId":"3b309b81-f0f0-4e84-87e4-b6192d35cd61","publishedId":"2s9Xy2QsPE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-10T03:17:13.000Z"},"item":[{"name":"Register User","id":"7b28d38f-7c76-4261-9965-a4c1b77b25d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Testman\",\r\n \"email\" :\"testman@gmail.com\",\r\n \"password\": \"hashedPassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://twofa-with-authenticator.onrender.com/api/auth/register","description":"

POST /register: Register a new user by providing the user's name, email, and password. If successful, the user is added to the database.

\n","urlObject":{"protocol":"https","path":["api","auth","register"],"host":["twofa-with-authenticator","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7b28d38f-7c76-4261-9965-a4c1b77b25d5"},{"name":"login User","id":"0c385ade-1d92-4a24-9e69-07c8c739213f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\" :\"testman@gmail.com\",\r\n \"password\": \"hashedPassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://twofa-with-authenticator.onrender.com/api/auth/login","description":"

POST /login: Log in a user by providing their email and password. If the login is successful, user details are returned, including OTP status.

\n","urlObject":{"protocol":"https","path":["api","auth","login"],"host":["twofa-with-authenticator","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c385ade-1d92-4a24-9e69-07c8c739213f"},{"name":"Generate Otp","id":"9eef6bb7-0f5d-41e6-97b4-3179397ef1de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://twofa-with-authenticator.onrender.com/api/auth/otp/generate?user_id=64d45c9fa479a13a55ac3937","description":"

POST /otp/generate: Generate an OTP for a user. The generated OTP is associated with the user and a QR code is generated for adding the OTP to an authenticator app.

\n","urlObject":{"protocol":"https","path":["api","auth","otp","generate"],"host":["twofa-with-authenticator","onrender","com"],"query":[{"key":"user_id","value":"64d45c9fa479a13a55ac3937"}],"variable":[]}},"response":[{"id":"13e8171b-dcdd-4398-855d-cef49ad43047","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"localhost:3000/api/auth/otp/generate?user_id=64d3d87b0a9aa1a5e724c9cd","host":["localhost"],"port":"3000","path":["api","auth","otp","generate"],"query":[{"key":"user_id","value":"64d3d87b0a9aa1a5e724c9cd"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"4897"},{"key":"ETag","value":"W/\"1321-aEwTF0sWNFSMvje8/RT90qFJCwY\""},{"key":"Date","value":"Thu, 10 Aug 2023 02:36:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n \n Generate OTP\n \n \n
\n \"QR\r\n \n
\n

Base32 Secret: \n AHMG4NBEQMXOVU2GSEFYGIUK\n

\n

OTP Auth URL: \n otpauth://totp/Ravebooking:Ravebooking%20splashray?issuer=Ravebooking&secret=AHMG4NBEQMXOVU2GSEFYGIUK&algorithm=SHA1&digits=6&period=15\n

\n \n"}],"_postman_id":"9eef6bb7-0f5d-41e6-97b4-3179397ef1de"},{"name":"Verify Otp","id":"16b8b7df-d941-4b2a-897f-4d658d0b730c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"64d45c9fa479a13a55ac3937\",\r\n \"token\": \"520823\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://twofa-with-authenticator.onrender.com/api/auth/otp/verify","description":"

POST /otp/verify: Verify an OTP provided by the user. If the OTP is valid, the user's OTP status is updated.

\n","urlObject":{"protocol":"https","path":["api","auth","otp","verify"],"host":["twofa-with-authenticator","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"5321f919-b324-4e69-9260-a9460cd1a610","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"64d3d87b0a9aa1a5e724c9cd\",\r\n \"token\": \"643774\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:3000/api/auth/otp/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"139"},{"key":"ETag","value":"W/\"8b-gAeXycDjFX+3XrRQx3WkVt4RaXs\""},{"key":"Date","value":"Wed, 09 Aug 2023 20:02:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"otp_verified\": true,\n \"user\": {\n \"id\": \"64d3d87b0a9aa1a5e724c9cd\",\n \"name\": \"splashray\",\n \"email\": \"Splashraycreations@gmail.com\",\n \"otp_enabled\": true\n }\n}"}],"_postman_id":"16b8b7df-d941-4b2a-897f-4d658d0b730c"},{"name":"Validate Otp","id":"18ba9a60-86ad-4fd5-ae2e-dab981c3364c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"64d45c9fa479a13a55ac3937\",\r\n \"token\": \"482702\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://twofa-with-authenticator.onrender.com/api/auth/otp/validate","description":"

POST /otp/validate: Validate an OTP provided by the user. The validation window is extended to allow for minor time discrepancies.

\n","urlObject":{"protocol":"https","path":["api","auth","otp","validate"],"host":["twofa-with-authenticator","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"76b96fa0-1a52-4aa1-9548-e95405ca6579","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"64d3d87b0a9aa1a5e724c9cd\",\r\n \"token\": \"013603\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:3000/api/auth/otp/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"56"},{"key":"ETag","value":"W/\"38-4S5Y8ESvcF71Bpn9dAG4Z0cRdj8\""},{"key":"Date","value":"Wed, 09 Aug 2023 20:08:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"otp_valid\": true,\n \"message\": \"Otp verified successfully\"\n}"}],"_postman_id":"18ba9a60-86ad-4fd5-ae2e-dab981c3364c"},{"name":"Disable Otp","id":"4081e3cb-f1f4-4880-bf87-329d24a2c89b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"64d45c9fa479a13a55ac3937\",\r\n \"token\": \"345979\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://twofa-with-authenticator.onrender.com/api/auth/otp/disable","description":"

POST /otp/disable: Disable OTP for a user.

\n","urlObject":{"protocol":"https","path":["api","auth","otp","disable"],"host":["twofa-with-authenticator","onrender","com"],"query":[],"variable":[]}},"response":[{"id":"23af1466-aadd-412e-886c-b36b89edab88","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"64d45c9fa479a13a55ac3937\",\r\n \"token\": \"345979\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://twofa-with-authenticator.onrender.com/api/auth/otp/disable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Aug 2023 03:47:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"7f45415dedfb0b5c-AMS"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"ETag","value":"W/\"9f-ohVutAJK+caSol9mTpEFmGwr61E\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"Express"},{"key":"x-render-origin-server","value":"Render"},{"key":"Server","value":"cloudflare"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"otp_disabled\": true,\n \"message\": \"Otp disabled successfully\",\n \"user\": {\n \"id\": \"64d45c9fa479a13a55ac3937\",\n \"name\": \"Seyi\",\n \"email\": \"seyi@gmail.com\",\n \"otp_enabled\": false\n }\n}"}],"_postman_id":"4081e3cb-f1f4-4880-bf87-329d24a2c89b"}]}