This API documentation assumes that a server similar to that descrbed under Simple usage is up and running on http://localhost:3000
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"283450","collectionId":"d5f2c47b-88d9-4524-8204-f530e01be1ad","publishedId":"2s946o2og3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-07-24T22:27:41.000Z"},"item":[{"name":"Authenthication","item":[{"name":"Connects (sign-in) a user","id":"01a63340-edc3-43dd-aa9f-29b8e45bf0d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"p_simmons\",\r\n \"password\": \"$a12dfy_\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/connect","urlObject":{"protocol":"http","port":"3000","path":["connect"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"62a6e475-cd2b-4976-93a3-5669121fd4c7","name":"Connects (sign-in) a user success same domain example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"a\",\r\n \"password\": \"a\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/connect"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Set-Cookie","value":"refresh_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTYyMzM5N30.IdxbeAHRHCn8LTLcSjKvkTPKbfos24eFRmWCquujPG0; Max-Age=86400; Path=/; Expires=Thu, 22 Dec 2022 11:49:57 GMT; HttpOnly; Secure"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"265"},{"key":"ETag","value":"W/\"109-2GYHwkXqrtBXkCfhwXUXLxDZX2o\""},{"key":"Date","value":"Wed, 21 Dec 2022 11:49:57 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTYyMzM5NywiZXhwIjoxNjcxNjI0Mjk3fQ.zBvkYJ9_VIZlbNFvMSfNvUjZu6V0N_baECJOXvEnDt4\",\n \"username\": \"p_simmons\",\n \"configData\": {\n \"rootDir\": \"root:\",\n \"sep\": \"\\\\\",\n \"gridFsStorage\": true\n }\n}"},{"id":"06863745-f4ad-49db-a0c3-798b6bdf5bff","name":"Connects (sign-in) a user failed same domain example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"p_simmons\",\r\n \"password\": \"$a12dfy_34\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/connect"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"92"},{"key":"ETag","value":"W/\"5c-LpLtFINiR3j8aRj6kvybr2x4+5o\""},{"key":"Date","value":"Wed, 21 Dec 2022 11:52:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"msg\": \"Initialization of file system failed. Incorrect password or username.\"\n}"},{"id":"2f5d9baf-5c35-43a7-a879-ec628feb5b67","name":"Connects (sign-in) a user success different domain example","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"http://localhost:5000","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"p_simmons\",\r\n \"password\": \"$a12dfy_\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/connect"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:5000"},{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"419"},{"key":"ETag","value":"W/\"1a3-aX+zhLLGFNfpN6MH6kADXLocFgo\""},{"key":"Date","value":"Thu, 22 Dec 2022 03:44:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTY4MDY4NCwiZXhwIjoxNjcxNjgxNTg0fQ.fd2mbls5_jtx4TShzd1VGdaFdutPwWLIE0mjDOL7HTo\",\n \"username\": \"p_simmons\",\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTY4MDY4NH0.pyCWuvI_vbgeY72tNIunIuIEo1zBIhz9vBO9xKDH_tU\",\n \"configData\": {\n \"rootDir\": \"root:\",\n \"sep\": \"\\\\\",\n \"gridFsStorage\": true\n }\n}"},{"id":"97a8ff91-d242-4467-9c23-37c015d437ea","name":"Connects (sign-in) a user failed different domain example","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"http://localhost:5000","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"p_simmons\",\r\n \"password\": \"$a12dfy_34\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/connect"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:5000"},{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"92"},{"key":"ETag","value":"W/\"5c-LpLtFINiR3j8aRj6kvybr2x4+5o\""},{"key":"Date","value":"Thu, 22 Dec 2022 03:49:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"msg\": \"Initialization of file system failed. Incorrect password or username.\"\n}"}],"_postman_id":"01a63340-edc3-43dd-aa9f-29b8e45bf0d7"},{"name":"Re-connects a user","id":"2de1c104-92ee-47d9-a6f7-86d1696108d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"p_simmons\",\r\n \"password\": \"$a12dfy_\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/re-connect","urlObject":{"protocol":"http","port":"3000","path":["re-connect"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2de1c104-92ee-47d9-a6f7-86d1696108d3"},{"name":"Disconnects (sign-out) a user","id":"1a339c39-e640-476d-9c9d-aad191c1ac4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"1a339c39-e640-476d-9c9d-aad191c1ac4e"},{"name":"Refreshes the user's authentication token","id":"e20eca93-7cee-4019-8282-6f1bc3eb21da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Origin","value":"http://localhost:5000","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refreshToken\":\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/refresh_token","urlObject":{"protocol":"http","port":"3000","path":["refresh_token"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"3ff85de0-3161-4828-bf5c-fd863c18b7de","name":"Refreshes the user's authentication token - success same domain example","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text"}],"url":"http://localhost:3000/refresh_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Set-Cookie","value":"refresh_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTY3OTI5MX0.Y_0BUqt-zX4TWLmM0HVp6q41piDZdgRuGSEyS-OWOM4; Max-Age=86400; Path=/; Expires=Fri, 23 Dec 2022 03:21:31 GMT; HttpOnly; Secure"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"197"},{"key":"ETag","value":"W/\"c5-OT3lf2M9wk/byHoGSwJ6b/dFBxw\""},{"key":"Date","value":"Thu, 22 Dec 2022 03:21:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTY3OTI5MSwiZXhwIjoxNjcxNjgwMTkxfQ.9EPY71sSzoKxGWej3111jAqhcrCn6LzY3nLagmDR-Xs\",\n \"refreshToken\": null\n}"},{"id":"8a460a4a-9ab1-41be-88f2-4acbd9668f37","name":"Refreshes the user's authentication token - failed same domain example","originalRequest":{"method":"POST","header":[],"url":"http://localhost:3000/refresh_token"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"48"},{"key":"ETag","value":"W/\"30-GYiBX65b5qzPgfWRteZoCERicRk\""},{"key":"Date","value":"Thu, 22 Dec 2022 03:24:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"No matching refresh token in database.\"\n}"},{"id":"ec6f7033-893a-4495-84de-1242761ba91c","name":"Refreshes the user's authentication token - success different domain example","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"http://localhost:5000","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTY4MTU4M30.wgLdSuY3XpJYJThEiPPFRvOsSfOSddsHdeSfU5UCPDs\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/refresh_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:5000"},{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"331"},{"key":"ETag","value":"W/\"14b-Q2ZnZVtcj92EMMnV5kOUZF1Kp0g\""},{"key":"Date","value":"Thu, 22 Dec 2022 04:00:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTY4MTYwNSwiZXhwIjoxNjcxNjgyNTA1fQ.dOSJbNJYm_reArBIz-iT9wFaCL_HmMqUW7cwlaP8koA\",\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InBfc2ltbW9ucyIsImlhdCI6MTY3MTY4MTYwNX0.qV4ibAANkBd4Ynfh8KLk2_5XRYie7D_bvTb2QXG9y1k\"\n}"},{"id":"84ebcbf3-555d-411f-8c0b-e80757f0c522","name":"Refreshes the user's authentication token - failed different domain example","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"http://localhost:5000","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/refresh_token"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:5000"},{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"48"},{"key":"ETag","value":"W/\"30-GYiBX65b5qzPgfWRteZoCERicRk\""},{"key":"Date","value":"Thu, 22 Dec 2022 04:01:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"No matching refresh token in database.\"\n}"}],"_postman_id":"e20eca93-7cee-4019-8282-6f1bc3eb21da"},{"name":"Register new user","id":"c2b358cf-8531-4c98-8b89-d95f1ae79ee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"simmons@yahoo.com\",\r\n \"username\": \"simmons\",\r\n \"password\": \"$a12dfy_\",\r\n \"repeat_password\": \"$a12dfy_\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/registerFs","urlObject":{"protocol":"http","port":"3000","path":["registerFs"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"c66a9e3b-39a2-4096-bacd-6dfa389120e7","name":"Register new user - successful example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"simmons@yahoo.com\",\r\n \"username\": \"simmons\",\r\n \"password\": \"$a12dfy_\",\r\n \"repeat_password\": \"$a12dfy_\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/registerFs"},"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":"48"},{"key":"ETag","value":"W/\"30-WvZHY9z5aOQXvwLOLeeVGW6CteA\""},{"key":"Date","value":"Tue, 25 Jul 2023 12:46:17 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Registration completed.\"\n}"},{"id":"de8bc067-ef5b-48bf-9ffe-3e47cbdbbd87","name":"Register new user - failed example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"p_simmons@yahoo.com\",\r\n \"username\": \"p_simmons\",\r\n \"password\": \"$a12dfy_\",\r\n \"repeat_password\": \"$a12dfy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/registerFs"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"130"},{"key":"ETag","value":"W/\"82-rfo2McKMz8vLEiTH6Y2Esuunmwg\""},{"key":"Date","value":"Tue, 25 Jul 2023 12:47:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Need a valid username, password and repeat password. Make sure the repeat password matches the password.\"\n}"}],"_postman_id":"c2b358cf-8531-4c98-8b89-d95f1ae79ee0"}],"id":"19168cc3-c4e0-4155-9a41-53fa227038a9","description":"These APIs create and maintain adequate authentication. It uses jsonwebtoken
\n","_postman_id":"19168cc3-c4e0-4155-9a41-53fa227038a9"},{"name":"File Read","item":[{"name":"Read file","id":"e3fcbf8d-6d89-4f90-8b4a-344973cd322c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"These APIs allow authenticated users to perform file read by operations.
\n","_postman_id":"c5ab7c7d-6d50-4a63-9678-1451d282d5e3"},{"name":"File Write","item":[{"name":"Write to a file","id":"d1cfc521-1011-4787-9b88-a96e7ad15ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"d1cfc521-1011-4787-9b88-a96e7ad15ad5"},{"name":"Append to a file","id":"5ff4853a-10d7-4557-b380-4f6f06b11582","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"5ff4853a-10d7-4557-b380-4f6f06b11582"}],"id":"265e8490-5492-407c-89c5-b4a97824e529","description":"These APIs allow authenticated users to perform file write by operations.
\n","_postman_id":"265e8490-5492-407c-89c5-b4a97824e529"},{"name":"Create","item":[{"name":"Creates a file","id":"bb42744a-7b74-4f4a-a0a7-7fe90773bdab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bb42744a-7b74-4f4a-a0a7-7fe90773bdab"},{"name":"Creates a folder","id":"7709b9f5-0372-46b6-9189-d583fefb1fb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"7709b9f5-0372-46b6-9189-d583fefb1fb8"}],"id":"5b744608-d08f-4a3e-8469-90af4d080856","description":"These APIs allow authenticated users to create new folders and files.
\n","_postman_id":"5b744608-d08f-4a3e-8469-90af4d080856"},{"name":"Delete","item":[{"name":"Revoves a folder","id":"9c573790-ad7c-4052-befc-615da5a7ec57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"9c573790-ad7c-4052-befc-615da5a7ec57"},{"name":"Removes a file","id":"bc751427-3881-4ee8-86ca-c5405e6b65a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bc751427-3881-4ee8-86ca-c5405e6b65a3"}],"id":"49269e60-f295-4000-808b-1acb084178d1","description":"These APIs allow authenticated users to delete existing folders and files.
\nEndFragment
\n","_postman_id":"49269e60-f295-4000-808b-1acb084178d1"},{"name":"Other","item":[{"name":"Gets a hierarchical tree data structure","id":"6aa3d20d-4908-462c-a3e2-de1ed8baa621","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"6aa3d20d-4908-462c-a3e2-de1ed8baa621"},{"name":"Tests a user's permissions for the file or directory","id":"606820c0-d73e-4788-b9c6-bb359964b262","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"606820c0-d73e-4788-b9c6-bb359964b262"},{"name":"Asynchronously copy a file","id":"744c5305-3480-412b-9f6f-6df19a6318bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"744c5305-3480-412b-9f6f-6df19a6318bc"},{"name":"Renames a file or folder path","id":"93725dba-e62d-425c-9e33-e8fd6ca58f62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"93725dba-e62d-425c-9e33-e8fd6ca58f62"},{"name":"Sets user specific configuation","id":"25154469-3fb6-45d0-9038-af72982e27df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"25154469-3fb6-45d0-9038-af72982e27df"},{"name":"Gets user specific configuration","id":"f0395f83-7b18-4506-9b10-762483a36af1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"f0395f83-7b18-4506-9b10-762483a36af1"}],"id":"73729bc1-73fe-44ed-b6da-80364651a332","description":"These APIs allow authenticated users to rename or copy folders and files and get and modify user specific configuration.
\nEndFragment
\n","_postman_id":"73729bc1-73fe-44ed-b6da-80364651a332"}]}