This is an API Documentation which consists the API Calls for Password Reset Flow - BackEnd App.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38692959","collectionId":"7887a8e6-af77-468a-b51e-db70ef273f86","publishedId":"2sAYBXDC7E","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-29T19:21:33.000Z"},"item":[{"name":"Register","id":"12149637-d116-4a4d-986d-a453b7e19213","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Testing Name\",\r\n \"email\":\"abc@gmail.com\",\r\n \"password\":\"TestPWD\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseuri}}/api/v1/register","description":"This api used to create an user in the databases. We have to use the Name, Email and the password for the user. Afte the successful registration, it generates an email containing the Login Information of the user.
\n","urlObject":{"path":["api","v1","register"],"host":["{{baseuri}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12149637-d116-4a4d-986d-a453b7e19213"},{"name":"Login","id":"05a97633-b0ae-46c7-b24f-5eaed3ae1c8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"abc@gmail.com\",\r\n \"password\":\"TestPWD\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseuri}}/api/v1/login","description":"This API endpoint is used to authenticate and login a user.
\nemail (string, required): The email address of the user.
\npassword (string, required): The password for the user account.
\nThe response of this request is a JSON schema, which will include the structure and data types of the response fields.
\n","urlObject":{"path":["api","v1","login"],"host":["{{baseuri}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05a97633-b0ae-46c7-b24f-5eaed3ae1c8a"},{"name":"UserInfo","event":[{"listen":"test","script":{"id":"91d3a0b5-e2da-4868-b0ba-42d2807e597f","exec":["\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"d148f549-0dba-4100-af88-25c92fc47b60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseuri}}/api/v1/userInfo","description":"This endpoint makes an HTTP GET request to retrieve user information from the API. The response of this request can be documented as a JSON schema to provide a structured description of the data format and types returned by the API.
\n","urlObject":{"path":["api","v1","userInfo"],"host":["{{baseuri}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d148f549-0dba-4100-af88-25c92fc47b60"},{"name":"Password Reset","id":"3ed2559b-0e22-4cce-8c2f-4244915eb781","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"abc@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseuri}}/api/v1/resetPassword","description":"This endpoint is used to initiate the process of resetting a user's password. It is accessed via an HTTP POST request to {{baseuri}}/api/v1/resetPassword. Using this api, we generate a token and email it to the user for resetting their password.
email (string, required): The email address of the user for whom the password reset is requested.The response will include the status of the password reset request.
\n","urlObject":{"path":["api","v1","resetPassword"],"host":["{{baseuri}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ed2559b-0e22-4cce-8c2f-4244915eb781"},{"name":"Signout","id":"70c49bcb-0843-4672-a3cc-753300424535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseuri}}/api/v1/signout","description":"This endpoint is used to sign out the user from the application. Upon successful execution of the request, the response will be a JSON schema representing the data returned by the sign out process.
\n","urlObject":{"path":["api","v1","signout"],"host":["{{baseuri}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"70c49bcb-0843-4672-a3cc-753300424535"},{"name":"Set New Password","id":"e34cc366-5cdd-4470-bc58-01451bba25a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"token\":\"fskvvll\",\r\n \"newPassword\":\"abcd\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseuri}}/api/v1/setNewPassword","description":"This endpoint is used to set a new password by sending an HTTP GET request to the specified URI. The request should include a token and the new password in the payload.
\ntoken (string): The token for verification. It is valid for 3 Hours from its generation
\nnewPassword (string): The new password to be set.
\nThe response of this request is represented as a JSON schema. The specific structure of the response will depend on the API implementation and may include various properties and data types.
\n","urlObject":{"path":["api","v1","setNewPassword"],"host":["{{baseuri}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e34cc366-5cdd-4470-bc58-01451bba25a9"}]}