{"info":{"_postman_id":"4626da91-10b7-44a2-ae5a-a5c96179240f","name":"Nest Authentication - No Docker","description":"

Welcome to the documentation for this simple, yet efficient authentication API built with the NestJS framework :)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25777649","collectionId":"4626da91-10b7-44a2-ae5a-a5c96179240f","publishedId":"2s9Ykodh7Q","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-19T14:42:01.000Z"},"item":[{"name":"Sign Up","id":"3b12e73f-c6da-4378-8543-23c8961af7db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"testUser\",\r\n \"email\": \"frainytes@gmail.com\",\r\n \"password\": \"secureYourPassword!33\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/users/signUp","description":"

Sign Up User

\n

This endpoint allows the client to sign up a new user by providing the user's name, email, and password.

\n

Request Body

\n\n

Example

\n
{\n    \"name\": \"John Doe\",\n    \"email\": \"johndoe@example.com\",\n    \"password\": \"secretpassword\"\n}\n\n
\n

Response

\n\n

Example Response

\n
{\n    \"message\": \"Verification link sent to email\",\n    \"link\": \"localhost:3002/users/confirm?_id=6581a7a8f3b293d7361a43de&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NTgxYTdhOGYzYjI5M2Q3MzYxYTQzZGUiLCJpYXQiOjE3MDI5OTU4ODAsImV4cCI6MTcwMjk5OTQ4MH0.ZNK3sPvNqnFT5-v-_C2F9jnWcvjN4oQqDmb6vDQaIPs\"\n}\n\n
\n","urlObject":{"path":["users","signUp"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6da12a69-6471-45ba-b0c4-d65ec7e9d58a","name":"Sign Up user","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"testUser\",\r\n \"email\": \"frainytes@gmail.com\",\r\n \"password\": \"secureYourPassword!33\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/users/signUp"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"295"},{"key":"ETag","value":"W/\"127-fqRYXj60eiqE93wun97bt7v2j88\""},{"key":"Date","value":"Tue, 19 Dec 2023 14:24:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Verification link sent to email\",\n \"link\": \"localhost:3002/users/confirm?_id=6581a7a8f3b293d7361a43de&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NTgxYTdhOGYzYjI5M2Q3MzYxYTQzZGUiLCJpYXQiOjE3MDI5OTU4ODAsImV4cCI6MTcwMjk5OTQ4MH0.ZNK3sPvNqnFT5-v-_C2F9jnWcvjN4oQqDmb6vDQaIPs\"\n}"}],"_postman_id":"3b12e73f-c6da-4378-8543-23c8961af7db"},{"name":"Email Verification Link","id":"bc67ab28-a5d0-4e2b-b48e-575e589848c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/users/confirm?_id=6581a7a8f3b293d7361a43de&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NTgxYTdhOGYzYjI5M2Q3MzYxYTQzZGUiLCJpYXQiOjE3MDI5OTU4ODAsImV4cCI6MTcwMjk5OTQ4MH0.ZNK3sPvNqnFT5-v-_C2F9jnWcvjN4oQqDmb6vDQaIPs","description":"

This endpoint sends an HTTP GET request to the specified URL to confirm user verification. It includes the user ID and a verification token as query parameters. The request does not include a request body.

\n

The response to the request has a status code of 200 and includes a message indicating the verification status and the updated user details. The updated user object contains the user's ID, name, email, password, and verification status.

\n

Example response:

\n
{\n    \"message\": \"You have been verified! You can successfully login now\",\n    \"updatedUser\": {\n        \"_id\": \"6581a7a8f3b293d7361a43de\",\n        \"name\": \"testUser\",\n        \"email\": \"frainytes@gmail.com\",\n        \"password\": \"$2a$10$/YqdoRfR9eRahwFt1NwZnODziFBSrtZ/O1iet84unG2uc8AV4EdFa\",\n        \"verified\": true\n    }\n}\n\n
\n","urlObject":{"path":["users","confirm"],"host":["{{base_url}}"],"query":[{"key":"_id","value":"6581a7a8f3b293d7361a43de"},{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NTgxYTdhOGYzYjI5M2Q3MzYxYTQzZGUiLCJpYXQiOjE3MDI5OTU4ODAsImV4cCI6MTcwMjk5OTQ4MH0.ZNK3sPvNqnFT5-v-_C2F9jnWcvjN4oQqDmb6vDQaIPs"}],"variable":[]}},"response":[{"id":"edd81d29-baec-4716-87d6-d4cd3d1735ec","name":"Confirm User","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/users/confirm?_id=6581a7a8f3b293d7361a43de&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NTgxYTdhOGYzYjI5M2Q3MzYxYTQzZGUiLCJpYXQiOjE3MDI5OTU4ODAsImV4cCI6MTcwMjk5OTQ4MH0.ZNK3sPvNqnFT5-v-_C2F9jnWcvjN4oQqDmb6vDQaIPs","host":["{{base_url}}"],"path":["users","confirm"],"query":[{"key":"_id","value":"6581a7a8f3b293d7361a43de"},{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NTgxYTdhOGYzYjI5M2Q3MzYxYTQzZGUiLCJpYXQiOjE3MDI5OTU4ODAsImV4cCI6MTcwMjk5OTQ4MH0.ZNK3sPvNqnFT5-v-_C2F9jnWcvjN4oQqDmb6vDQaIPs"}]}},"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":"255"},{"key":"ETag","value":"W/\"ff-fNqsKaHKtIJU8w9j5TVVC9nr99U\""},{"key":"Date","value":"Tue, 19 Dec 2023 14:26:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You have been verified! You can successfully login now\",\n \"updatedUser\": {\n \"_id\": \"6581a7a8f3b293d7361a43de\",\n \"name\": \"testUser\",\n \"email\": \"frainytes@gmail.com\",\n \"password\": \"$2a$10$/YqdoRfR9eRahwFt1NwZnODziFBSrtZ/O1iet84unG2uc8AV4EdFa\",\n \"verified\": true\n }\n}"}],"_postman_id":"bc67ab28-a5d0-4e2b-b48e-575e589848c7"},{"name":"User Login","id":"ff3e9d34-c6e7-4713-a7b0-f37ac000b7e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"frainytes@gmail.com\",\r\n \"password\": \"secureYourPassword!33\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/users/login","description":"

This endpoint is used to log in a user. The request should be sent as an HTTP POST to the specified URL. The request body should contain the user's email and password in JSON format.

\n

Request Body

\n\n

Response

\n

A successful request will return a message indicating that the specified user has been logged in.

\n

Example:

\n
testUser is logged in!\n\n
","urlObject":{"path":["users","login"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"464adeab-0fd6-4b00-8290-f3a019d92288","name":"Login User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"frainytes@gmail.com\",\r\n \"password\": \"secureYourPassword!33\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/users/login"},"status":"Created","code":201,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Set-Cookie","value":"Authentication=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NTgxYTdhOGYzYjI5M2Q3MzYxYTQzZGUiLCJpYXQiOjE3MDI5OTYxODQsImV4cCI6MTcwMjk5OTc4NH0.xq6CaVLMH1dFBoq9zfoJPUo4wS3lt9Pfky3qrVcgfZs; Path=/; Expires=Sun, 24 Dec 2023 17:42:20 GMT; HttpOnly"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"22"},{"key":"ETag","value":"W/\"16-Um1DL5kR4Xrkyj4jhyWZeZyvWNE\""},{"key":"Date","value":"Tue, 19 Dec 2023 14:29:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"testUser is logged in!"}],"_postman_id":"ff3e9d34-c6e7-4713-a7b0-f37ac000b7e3"}]}