{ "openapi": "3.0.3", "info": { "version": "1.0.0", "title": "API documenations using Swagger", "description": "Sample project which generates API documentaion using swagger.", "contact": { "name": "Gilbert D. Cuerbo", "email": "gilbert.cuerbo@gmail.com" }, "license": { "name": "MIT", "url": "https://github.com/gilbertgit95/kagiweb-api-core-a/blob/master/LICENSE" } }, "servers": [ { "url": "localhost:5000/api/core/v1/" } ], "tags": [ { "name": "Auths", "description": "Contains all endpoints related to roles. This will give a package access to accounts" }, { "name": "Features", "description": "Contains all endpoints related to features. This will be the bases for account access in the roles" }, { "name": "Roles", "description": "Contains all endpoints related to roles. This will give a package access to accounts" }, { "name": "Accounts", "description": "Contains all endpoints related to accounts." }, { "name": "Owner", "description": "Contains all endpoints related to the current signedin account." } ], "paths": { "/signin": { "post": { "tags": [ "Auths" ], "security": [], "summary": "Signin to the application to get jwt", "description": "Signin to the application to get jwt. If signin limited transaction is enabled then after certain\nnumber of signin attempts the account will be disabled, if signin successfull it will return object containing jwt, nameId and message\nIf otp signin is enabled, generate otp code and send it to a account contact, also it will return nameId and message.\n", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId", "password" ], "properties": { "nameId": { "type": "string" }, "password": { "type": "string", "format": "password" } } } } } }, "responses": { "200": { "description": "jwt response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nameId": { "type": "string" }, "token": { "type": "string" }, "message": { "type": "string" }, "expiration": { "type": "date" }, "createdAt": { "type": "date" } } }, "example": { "nameId": "master", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTIyNzU3MjEsImV4cCI6MTY5MjM2MjEyMX0.S1fexk-lZlEjzJsmV2nY8Gk_2nY_Cy8mGuRT-Nx8nmk", "message": "Successful signin", "expiration": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-07T03:10:24.423Z" } } } }, "400": { "description": "Incorrect content in the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Incorrect content in the request." } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Resource not found." } } } }, "423": { "description": "locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "locked" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Internal server error." } } } } } } }, "/signinOTP": { "post": { "tags": [ "Auths" ], "security": [], "summary": "OTP Signin to the application to get jwt", "description": "OTP Signin to the application to get jwt. At certain number of otp-signin attempts, the account will be disable for security reason.\nIf otp sign in is successfull then this will return jwt and message.\n", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId", "key" ], "properties": { "nameId": { "type": "string" }, "key": { "type": "string" } } } } } }, "responses": { "200": { "description": "jwt response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nameId": { "type": "string" }, "token": { "type": "string" }, "message": { "type": "string" }, "expiration": { "type": "date" }, "createdAt": { "type": "date" } } }, "example": { "nameId": "master", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTIyNzU3MjEsImV4cCI6MTY5MjM2MjEyMX0.S1fexk-lZlEjzJsmV2nY8Gk_2nY_Cy8mGuRT-Nx8nmk", "message": "Successful signin", "expiration": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-07T03:10:24.423Z" } } } }, "400": { "description": "Incorrect content in the request.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Incorrect content in the request." } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Resource not found." } } } }, "423": { "description": "locked", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "locked" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Internal server error." } } } } } } }, "/signup": { "post": { "tags": [ "Auths" ], "security": [], "summary": "Create a account account.", "description": "Create a account account. This will register initial account information like nameId password and account contact.\nHowever the created account is still disabled and not yet verified, You still need to contact administrator\nto enable and verify your account.\n", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId", "password" ], "properties": { "nameId": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string", "description": "email address (optional)" }, "phone": { "type": "string", "description": "mobile phone number (optional)" } } } } } }, "responses": { "200": { "description": "jwrt response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nameId": { "type": "string" } } }, "example": { "nameId": "master" } } } }, "400": { "description": "Incorrect content in the request.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Incorrect content in the request." } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Resource not found." } } } }, "423": { "description": "locked", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "locked" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Internal server error." } } } } } } }, "/forgotPassword": { "post": { "tags": [ "Auths" ], "security": [], "summary": "File a forgot request password.", "description": "File a forgot request password. If the account have a verified contact, then a passwprd reset key\nwill be sent to the contact address. However no contact are registered or no verified contact, then the reset password key\nwill be sent to the administrator as default contact.\n", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId" ], "properties": { "nameId": { "type": "string" } } } } } }, "responses": { "200": { "description": "jwrt response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nameId": { "type": "string" }, "message": "string" } }, "example": { "nameId": "master", "message": "Password reset key has been sent" } } } }, "400": { "description": "Incorrect content in the request.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Incorrect content in the request." } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Resource not found." } } } }, "423": { "description": "locked", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "locked" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Internal server error." } } } } } } }, "/resetPassword": { "put": { "tags": [ "Auths" ], "security": [], "summary": "Reset the password using otp key.", "description": "Reset the password using otp key. To proceed changing the password,\nuse the change password key sent to the account contact, nameId and the new password you want.\n", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId", "key", "newPassword" ], "properties": { "nameId": { "type": "string" }, "key": { "type": "string" }, "newPassword": { "type": "string" } } } } } }, "responses": { "200": { "description": "jwt response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Password has been changed" } } } }, "400": { "description": "Incorrect content in the request.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Incorrect content in the request." } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Resource not found." } } } }, "423": { "description": "locked", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "locked" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Internal server error." } } } } } } }, "/signout": { "delete": { "tags": [ "Auths" ], "summary": "Signout to the application, remove access token from account device", "description": "Signout to the application. This will remove the access token from the account devices.", "produces": [ "application/json" ], "responses": { "200": { "description": "okay message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "account has logged out" } } } }, "400": { "description": "Incorrect content in the request.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Incorrect content in the request." } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Error" }, "example": { "message": "Internal server error." } } } } } } }, "/features": { "get": { "tags": [ "Features" ], "summary": "Get paginated features", "description": "Get paginated features. The default size of pagination is 100.", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "paginated features", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Feature" } ] } } } } ] }, "example": { "items": [ { "_id": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "description": "One of the server endpoint", "name": "GET \\api\\v1\\systemInfo", "tags": [ "Server", "Api Route", "GET" ], "type": "api-route", "updatedAt": "2023-08-07T03:10:24.423Z", "value": "[GET]_\\api\\v1\\systemInfo" } ], "totalItems": 1, "page": 1, "pageSize": 100, "totalPages": 1, "nextURL": null } } } } } ] } }, "post": { "tags": [ "Features" ], "summary": "Create a Feature", "description": "Create a Feature. features are used for access control. If a value is already existing, a conflict status will be thrown.", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "api-route", "ui-route", "ui-module" ], "description": "this is use to categorize features" }, "value": { "type": "string", "description": "this is the value that the access middleware will check." }, "name": { "type": "string", "description": "to make a account friendly identifier" }, "tags": { "type": "array", "item": { "type": "string" }, "description": "this value will be used in the UI to further categorize features like directories" }, "description": { "type": "string" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull feature creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Feature" } ] }, "example": { "_id": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "description": "One of the server endpoint", "name": "GET \\api\\v1\\systemInfo", "tags": [ "Server", "Api Route", "GET" ], "type": "api-route", "updatedAt": "2023-08-07T03:10:24.423Z", "value": "[GET]_\\api\\v1\\systemInfo" } } } } } ] } } }, "/features/{id}": { "get": { "tags": [ "Features" ], "summary": "Get a Feature", "description": "Get a Feature", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the feature to get", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull feature fetching", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Feature" } ] }, "example": { "_id": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "description": "One of the server endpoint", "name": "GET \\api\\v1\\systemInfo", "tags": [ "Server", "Api Route", "GET" ], "type": "api-route", "updatedAt": "2023-08-07T03:10:24.423Z", "value": "[GET]_\\api\\v1\\systemInfo" } } } } } ] } }, "put": { "tags": [ "Features" ], "summary": "Update a Feature", "description": "Update a Feature. If value is being updated and is already existing, a conflict status will be thrown.", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the feature to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "api-route", "ui-route", "ui-module" ], "description": "this is use to categorize features" }, "value": { "type": "string", "description": "this is the value that the access middleware will check." }, "name": { "type": "string", "description": "to make a account friendly identifier" }, "tags": { "type": "array", "item": { "type": "string" }, "description": "this value will be used in the UI to further categorize features like directories" }, "description": { "type": "string" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull feature update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Feature" } ] }, "example": { "_id": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "description": "One of the server endpoint", "name": "GET \\api\\v1\\systemInfo", "tags": [ "Server", "Api Route", "GET" ], "type": "api-route", "updatedAt": "2023-08-07T03:10:24.423Z", "value": "[GET]_\\api\\v1\\systemInfo" } } } } } ] } }, "delete": { "tags": [ "Features" ], "summary": "Delete a Feature", "description": "Delete a Feature", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the feature to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull feature deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Feature" } ] }, "example": { "_id": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "description": "One of the server endpoint", "name": "GET \\api\\v1\\systemInfo", "tags": [ "Server", "Api Route", "GET" ], "type": "api-route", "updatedAt": "2023-08-07T03:10:24.423Z", "value": "[GET]_\\api\\v1\\systemInfo" } } } } } ] } } }, "/roles": { "get": { "tags": [ "Roles" ], "summary": "Get paginated Roles.", "description": "Get paginated Roles. Defult size for each page is 100.", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "allOf": [ { "400": { "description": "Incorrect content in the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Incorrect content in the request." } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Unauthorized." } } } }, "403": { "description": "Forbidden access to resources.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Forbidden access to resources." } } } }, "404": { "description": "Resources not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Resources not found." } } } }, "405": { "description": "Not Allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Not Allowed." } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Internal server error" } } } } }, { "200": { "description": "array of roles", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] } } } } ] }, "example": { "items": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" } ], "page": 1, "pageSize": 100, "totalPages": 1, "nextURL": null } } } } } ] } }, "post": { "tags": [ "Roles" ], "summary": "Create a Role.", "description": "Create a Role. If a role is already existing then this will throw a conflict error.", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "name", "level" ], "properties": { "name": { "type": "string", "description": "the name identifier for the role" }, "level": { "type": "string", "description": "this will be the indicator of the highest to lowest access writes of a role" }, "reqLimitPerSec": { "type": "number" }, "description": { "type": "string" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" } } } } } ] } } }, "/roles/{id}": { "get": { "tags": [ "Roles" ], "summary": "Get a Role", "description": "Get a Role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the role to get", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" } } } } } ] } }, "put": { "tags": [ "Roles" ], "summary": "Update a Role", "description": "Update a Role. If the name or level is beign updated and the values are already existing then this will throw a conflict error", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the role to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "the name identifier for the role" }, "level": { "type": "string", "description": "this will be the indicator of the highest to lowest access writes of a role" }, "reqLimitPerSec": { "type": "number" }, "description": { "type": "string" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" } } } } } ] } }, "delete": { "tags": [ "Roles" ], "summary": "Delete a Roles", "description": "Delete a Roles", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the role to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" } } } } } ] } } }, "/roles/{roleId}/features": { "get": { "tags": [ "Roles" ], "summary": "Get all the Roles features", "description": "Get all the Roles features", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of role features", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/RoleFeature" } ] } } } } ] } }, "example": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ] } } } } ] } }, "post": { "tags": [ "Roles" ], "summary": "Create a Role Feature", "description": "Create a Role Feature", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "featureId" ], "properties": { "featureId": { "type": "string", "format": "uuid" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role feature creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/RoleFeature" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } } } } } ] } } }, "/roles/{roleId}/features/{featureRefId}": { "get": { "tags": [ "Roles" ], "summary": "Get a Role Feature", "description": "Get a Role Feature", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "featureRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching role feature", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/RoleFeature" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" } } } } } ] } }, "put": { "tags": [ "Roles" ], "summary": "Update a Role feature", "description": "Update a Role feature", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "featureRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "featureId" ], "properties": { "featureId": { "type": "string", "format": "uuid" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role feature update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/RoleFeature" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" } } } } } ] } }, "delete": { "tags": [ "Roles" ], "summary": "Delete a Role Feature", "description": "Delete a Role Feature", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "featureRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role feature deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/RoleFeature" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" } } } } } ] } } }, "/roles/{roleId}/cloneFeatures": { "put": { "tags": [ "Roles" ], "summary": "This will clone features from other role to this role", "description": "This will clone features from other role to this role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "fromRoleId" ], "properties": { "fromRoleId": { "type": "string", "format": "uuid" }, "overwrite": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull role features cloning", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/RoleFeature" } ] } }, "example": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ] } } } } ] } } }, "/accounts": { "get": { "tags": [ "Accounts" ], "summary": "Get all the Accounts", "description": "Get all the Accounts", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "paginated accounts", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] } } } } ] }, "example": { "items": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } ], "page": 1, "pageSize": 100, "totalPages": 1, "nextURL": null } } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a Accounts", "description": "Create a Account", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId" ], "properties": { "nameId": { "type": "string" }, "disabled": { "type": "boolean", "description": "not accessable accounts" }, "verified": { "type": "boolean", "description": "not verified accounts are similar to pending account creation request" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } } } } } ] } } }, "/accounts/{id}": { "get": { "tags": [ "Accounts" ], "summary": "fetch a account", "description": "fetch a account", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the account in the database.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetch a account", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account", "description": "Update a account", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the account in the database.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nameId": { "type": "string" }, "disabled": { "type": "boolean", "description": "not accessable accounts" }, "verified": { "type": "boolean", "description": "not verified accounts are similar to pending account creation request" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Create a Accounts", "description": "Create a Account", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the account in the database.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } } } } } ] } } }, "/accounts/{id}/completeInfo": { "get": { "tags": [ "Accounts" ], "summary": "fetch a account and its complete info", "description": "fetch a account and its complete info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "this the uuid of the account in the database.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetch a account complete info", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountData": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "role": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] }, "roles": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] } }, "features": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Feature" } ] } }, "workspace": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "workspaces": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] } }, "clientDevice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "accessToken": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] } } } }, "example": { "accountData": { "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false }, "role": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" }, "roles": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" } ], "features": [ { "_id": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "description": "One of the server endpoint", "name": "GET \\api\\v1\\systemInfo", "tags": [ "Server", "Api Route", "GET" ], "type": "api-route", "updatedAt": "2023-08-07T03:10:24.423Z", "value": "[GET]_\\api\\v1\\systemInfo" } ], "workspace": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "name": "Default Workspace", "description": "test workspace.", "featuresRefs": [ { "_id": "bea762cf-aceb-41ce-b6bf-410ad69ffc9d", "accountId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-27T14:51:58.605Z", "updatedAt": "2023-08-31T14:34:32.748Z", "createdBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "modifiedBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" } ], "owner": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "modifiedBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "isActive": true, "disabled": false }, "workspaces": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "name": "Default Workspace", "description": "test workspace.", "featuresRefs": [ { "_id": "bea762cf-aceb-41ce-b6bf-410ad69ffc9d", "accountId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-27T14:51:58.605Z", "updatedAt": "2023-08-31T14:34:32.748Z", "createdBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "modifiedBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" } ], "owner": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "modifiedBy": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "isActive": true, "disabled": false } ], "clientDevice": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": null, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accessToken": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ] } } } } } ] } } }, "/accounts/{accountId}/roles": { "get": { "tags": [ "Accounts" ], "summary": "Get all the Account Roles", "description": "Get all the Account Roles", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account role", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] } } } } ] } }, "example": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a Account Role", "description": "Create a Account Role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "roleId" ], "properties": { "roleId": { "type": "string", "format": "uuid" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account role creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] }, "example": { "id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } } } } } ] } } }, "/accounts/{accountId}/roles/{roleRefId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a Account Role", "description": "Get a Account Role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "roleRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account role", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] }, "example": { "id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a Account Role", "description": "Update a Account Role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "roleRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account role update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] }, "example": { "id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "isActive": true, "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete a Account Role", "description": "Delete a Account Role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "roleRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account role deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] }, "example": { "id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "isActive": true, "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } } } } } ] } } }, "/accounts/{accountId}/accountInfos": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account informations", "description": "Get all the account informations", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account infos", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a account info into account data", "description": "Create a account info into account data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "key", "value", "type" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "date", "boolean" ] } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account info creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/accountInfos/{accountInfoId}": { "$ref": "#/paths/~1accounts~1%7BaccountId%7D~1accountInfos" }, "/accounts/{accountId}/accountConfigs": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account configrmations", "description": "Get all the account configrmations", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account configs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountConfig" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "default-workspace", "value": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } } }, "/accounts/{accountId}/accountConfigs/{accountConfigId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a account config", "description": "Get a account config", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountConfigId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account config", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountConfig" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "default-workspace", "value": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account config", "description": "Update a account config", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountConfigId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "value": { "type": "string" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account config update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountConfig" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "default-workspace", "value": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/contactInfos": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account contact informations", "description": "Get all the account contact informations. Account contact information can be many types of account info\nlike firstname, middlename, lastname, nirthdarte, bithplace and more\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account contact infos", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a account contact info into account data", "description": "Create a account contact info into account data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "email-address", "mobile-number", "telephone", "app-admin" ] }, "value": { "type": "string" }, "countryCode": { "type": "string" }, "verified": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account contact info creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/contactInfos/{contactInfoId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a account contact info", "description": "Get a account contact info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "contactInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account contact info", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account contact info", "description": "Update a account contact info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "contactInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email-address", "mobile-number", "telephone", "app-admin" ] }, "value": { "type": "string" }, "countryCode": { "type": "string" }, "verified": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account contact info update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete a account contact info", "description": "Delete a account contact info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "contactInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account contact info deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/passwords": { "get": { "tags": [ "Accounts" ], "summary": "Get all the passwords history of a account", "description": "Get all the passwords history of a account", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account infos", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a account info into account data", "description": "Create a account info into account data, recieves the new password and also the current password to validate the account, also check that the new password is not equal to any password in the history, disable the current password, and insert the new password with active status", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "currentPassword", "newPassword" ], "properties": { "currentPassword": { "type": "string", "format": "password" }, "newPassword": { "type": "string", "format": "password" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account info creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/passwords/{passwordId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a password", "description": "Get a password", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "passwordId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching password", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete a password", "description": "Delete a password, only be able to delete those password/s that are not active", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "passwordId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull password deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/limitedTransactions": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account limited transactions", "description": "Get all the account limited transactions", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account limited transaction", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountLimitedTransaction" } ] } } } } ] } }, "example": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "reset-pass", "key": 419188, "value": "test", "expTime": "2023-09-08T02:31:09.082Z", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } } }, "/accounts/{accountId}/limitedTransactions/{limitedTransactionId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a account limited transaction", "description": "Get a account limited transaction", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "limitedTransactionId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account limited transaction", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountLimitedTransaction" } ] }, "example": { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "reset-pass", "key": 419188, "value": "test", "expTime": "2023-09-08T02:31:09.082Z", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account limited transaction", "description": "Update a account limited transaction", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "limitedTransactionId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "number" }, "attempts": { "type": "number" }, "key": { "type": "string" }, "value": { "type": "string" }, "recipient": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account limited transaction update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountLimitedTransaction" } ] }, "example": { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "reset-pass", "key": 419188, "value": "test", "expTime": "2023-09-08T02:31:09.082Z", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/clientDevices": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account client device", "description": "Get all the account client device", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account client devices", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a account client device into account data", "description": "Create a account client device into account data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "ua" ], "properties": { "ua": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account client device creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/clientDevices/{clientDeviceId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a account client device", "description": "Get a account client device", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account client device", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account client device", "description": "Update a account client device", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ua": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account client device update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete a account client device", "description": "Delete a account client device", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account client device deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/clientDevices/{clientDeviceId}/accessTokens": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account client device access token", "description": "Get all the account client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account client device access tokens", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] } } } } ] } }, "example": [ { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a account client device access token into account data", "description": "Create a account client device access token into account data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "expiration": { "type": "number" }, "description": { "type": "string" }, "ipAddress": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account client device access token creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/clientDevices/{clientDeviceId}/accessTokens/{accessTokenId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a account client device access token", "description": "Get a account client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accessTokenId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account client device access token", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account client device access token", "description": "Update a account client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accessTokenId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "ipAddress": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account client device access token update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete a account client device access token", "description": "Delete a account client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accessTokenId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account client device access token deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/workspaces": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account workspaces", "description": "Get all the account workspaces", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account workspaces", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a account workspace into account data", "description": "Create a account workspace into account data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "disbled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account workspace creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/accounts/{accountId}/workspaces/{workspaceId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a account workspace", "description": "Get a account workspace", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account workspace", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account workspace", "description": "Update a account workspace", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "disbled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account workspace update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete a account workspace", "description": "Delete a account workspace", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account workspace deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } } }, "/accounts/{accountId}/workspaces/{workspaceId}/accountRefs": { "get": { "tags": [ "Accounts" ], "summary": "Get all the account workspace account references", "description": "Get all the account workspace account references", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account workspace account references", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "type": "object", "properties": { "nameId": { "type": "string" } } }, { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] } } } } ] } }, "example": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "nameId": "Bertwo", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ] } } } } ] } }, "post": { "tags": [ "Accounts" ], "summary": "Create a account workspace account reference into account data", "description": "Create a account workspace account reference into account data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId" ], "properties": { "nameId": { "type": "string" }, "readAccess": { "type": "boolean" }, "updateAccess": { "type": "boolean" }, "createAccess": { "type": "boolean" }, "deleteAccess": { "type": "boolean" }, "accepted": { "type": "boolean" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account workspace account reference creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } } }, "/accounts/{accountId}/workspaces/{workspaceId}/accountRefs/{accountRefId}": { "get": { "tags": [ "Accounts" ], "summary": "Get a account workspace account reference", "description": "Get a account workspace account reference", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account workspace account reference", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "nameId": { "type": "string" } } }, { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "nameId": "Bertwo", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "put": { "tags": [ "Accounts" ], "summary": "Update a account workspace account reference", "description": "Update a account workspace account reference", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "readAccess": { "type": "boolean" }, "updateAccess": { "type": "boolean" }, "createAccess": { "type": "boolean" }, "deleteAccess": { "type": "boolean" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account workspace account reference update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete a account workspace account reference", "description": "Delete a account workspace account reference", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account workspace account reference deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } } }, "/owner": { "get": { "tags": [ "Owner" ], "summary": "fetch owner data", "description": "fetch owner data", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetch owner data", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update owner data", "description": "Update owner data", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nameId": { "type": "string" }, "disabled": { "type": "boolean", "description": "not accessable accounts" }, "verified": { "type": "boolean", "description": "not verified accounts are similar to pending account creation request" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "example": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } } } } } ] } } }, "/owner/completeInfo": { "get": { "tags": [ "Owner" ], "summary": "fetch owner complete info", "description": "fetch owner complete info", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetch owner complete info", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountData": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Account" } ] }, "role": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] }, "roles": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Role" } ] } }, "features": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/Feature" } ] } }, "workspace": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "workspaces": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] } }, "externalWorkspaces": { "type": "array", "items": { "type": "object", "allOf": [ { "type": "object", "properties": { "ownerId": { "type": "string" }, "ownerAccountname": { "type": "string" } } }, { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] } }, "clientDevice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "accessToken": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] } } } }, "example": { "accountData": { "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false }, "role": { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" }, "roles": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" }, { "_id": "cbe58c3c-9d86-466c-a8b4-2b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "03b2f7f8-119f-4a7b-a9ea-af732a90f56a" }, { "_id": "cbe58c3c-9d86-466c-a8b4-3b26c379f276", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z", "featureId": "c2b6d920-a101-45e5-bbdb-0f6a07da1f33" } ], "level": 1, "reqLimitPerSec": 10, "name": "Manager" } ], "features": [ { "_id": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "description": "One of the server endpoint", "name": "GET \\api\\v1\\systemInfo", "tags": [ "Server", "Api Route", "GET" ], "type": "api-route", "updatedAt": "2023-08-07T03:10:24.423Z", "value": "[GET]_\\api\\v1\\systemInfo" } ], "workspace": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "isActive": true, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" }, "workspaces": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "isActive": true, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "externalWorkspaces": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "isActive": true, "disabled": false, "ownerId": "7e4ad416-4a8e-48d7-ae8b-740b1dade87f", "ownerAccountname": "master101", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "clientDevice": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": null, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accessToken": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ] } } } } } ] } } }, "/owner/roles": { "get": { "tags": [ "Owner" ], "summary": "Get all the owner roles", "description": "Get all the owner roles", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of owner role", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] } } } } ] } }, "example": [ { "_id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } ] } } } } ] } } }, "/owner/roles/{roleRefId}": { "get": { "tags": [ "Owner" ], "summary": "Get a owner Role", "description": "Get a owner Role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching owner role", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] }, "example": { "id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete owner Role", "description": "Delete owner Role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roleRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner role deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] }, "example": { "id": "cbe58c3c-9d86-466c-a8b4-1b26c379f276", "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-06T18:03:06.290Z", "updatedAt": "2023-08-07T03:10:24.423Z" } } } } } ] } } }, "/owner/accountInfos": { "get": { "tags": [ "Owner" ], "summary": "Get all the account informations", "description": "Get all the account informations", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account infos", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Owner" ], "summary": "Create a account info into account data", "description": "Create a account info into account data", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "key", "value", "type" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "date", "boolean" ] } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account info creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/accountInfos/{accountInfoId}": null, "/owner/accountConfigs": { "get": { "tags": [ "Owner" ], "summary": "Get all the account configs", "description": "Get all the account configs", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account configs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountConfig" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "default-workspace", "value": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } } }, "/owner/accountConfigs/{accountConfigId}": { "get": { "tags": [ "Owner" ], "summary": "Get a account info", "description": "Get a account info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account info", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update a account info", "description": "Update a account info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "date", "boolean" ] } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account info update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete a account info", "description": "Delete a account info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "accountInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account info deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/contactInfos": { "get": { "tags": [ "Owner" ], "summary": "Get all the owner contact informations", "description": "Get all the owner contact informations", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of owner contact infos", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Owner" ], "summary": "Create owner contact info into account data", "description": "Create owner contact info into account data", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "email-address", "mobile-number", "telephone", "app-admin" ] }, "value": { "type": "string" }, "countryCode": { "type": "string" }, "verified": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner contact info creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/contactInfos/{contactInfoId}": { "get": { "tags": [ "Owner" ], "summary": "Get owner contact info", "description": "Get owner contact info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "contactInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching owner contact info", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update owner contact info", "description": "Update owner contact info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "contactInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email-address", "mobile-number", "telephone", "app-admin" ] }, "value": { "type": "string" }, "countryCode": { "type": "string" }, "verified": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner contact info update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete owner contact info", "description": "Delete owner contact info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "contactInfoId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner contact info deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/passwords": { "get": { "tags": [ "Owner" ], "summary": "Get all the passwords history of the owner", "description": "Get all the passwords history of the owner", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of account passwords", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Owner" ], "summary": "Create a account password into owner data", "description": "Create a account password into owner data, recieves the new password and also the current password to validate the account, also check that the new password is not equal to any password in the history, disable the current password, and insert the new password with active status", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "currentPassword", "newPassword" ], "properties": { "currentPassword": { "type": "string", "format": "password" }, "newPassword": { "type": "string", "format": "password" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account password creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/passwords/{passwordId}": { "get": { "tags": [ "Owner" ], "summary": "Get a password", "description": "Get a password", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "passwordId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching password", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete a password", "description": "Delete a password, only be able to delete those password/s that are not active", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "passwordId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull password deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "key": "NA", "isActive": true, "expTime": "2023-08-07T03:10:24.423Z", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/limitedTransactions": { "get": { "tags": [ "Owner" ], "summary": "Get all the owner limited transactions", "description": "Get all the owner limited transactions", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of owner limited transaction", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountLimitedTransaction" } ] } } } } ] } }, "example": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "reset-pass", "key": 419188, "value": "test", "expTime": "2023-09-08T02:31:09.082Z", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } } }, "/owner/limitedTransactions/{limitedTransactionId}": { "get": { "tags": [ "Owner" ], "summary": "Get owner limited transaction", "description": "Get owner limited transaction", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "limitedTransactionId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching account limited transaction", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountLimitedTransaction" } ] }, "example": { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "reset-pass", "key": 419188, "value": "test", "expTime": "2023-09-08T02:31:09.082Z", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update owner limited transaction", "description": "Update owner limited transaction", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "limitedTransactionId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "number" }, "attempts": { "type": "number" }, "key": { "type": "string" }, "value": { "type": "string" }, "recipient": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull account limited transaction update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountLimitedTransaction" } ] }, "example": { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "reset-pass", "key": 419188, "value": "test", "expTime": "2023-09-08T02:31:09.082Z", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/clientDevices": { "get": { "tags": [ "Owner" ], "summary": "Get all the owner client device", "description": "Get all the owner client device", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of owner client devices", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Owner" ], "summary": "Create a owner client device into owner data", "description": "Create a owner client device into owner data", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "ua" ], "properties": { "ua": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner client device creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/clientDevices/{clientDeviceId}": { "get": { "tags": [ "Owner" ], "summary": "Get owner client device", "description": "Get owner client device", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching owner client device", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update owner client device", "description": "Update owner client device", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ua": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner client device update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete owner client device", "description": "Delete owner client device", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner client device deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/clientDevices/{clientDeviceId}/accessTokens": { "get": { "tags": [ "Owner" ], "summary": "Get all the owner client device access token", "description": "Get all the owner client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of owner client device access tokens", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] } } } } ] } }, "example": [ { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Owner" ], "summary": "Create a owner client device access token into owner data", "description": "Create a owner client device access token into owner data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "expiration": { "type": "number" }, "description": { "type": "string" }, "ipAddress": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner client device access token creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/clientDevices/{clientDeviceId}/accessTokens/{accessTokenId}": { "get": { "tags": [ "Owner" ], "summary": "Get owner client device access token", "description": "Get owner client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accessTokenId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching owner client device access token", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update owner client device access token", "description": "Update owner client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accessTokenId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "ipAddress": { "type": "string" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner client device access token update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete owner client device access token", "description": "Delete owner client device access token", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "clientDeviceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accessTokenId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner client device access token deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } ] }, "example": { "id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/workspaces": { "get": { "tags": [ "Owner" ], "summary": "Get all the owner workspaces", "description": "Get all the owner workspaces", "produces": [ "application/json" ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of owner workspaces", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] } } } } ] } }, "example": [ { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } ] } } } } ] } }, "post": { "tags": [ "Owner" ], "summary": "Create owner workspace into account data", "description": "Create owner workspace into account data", "produces": [ "application/json" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "disbled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner workspace creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-08-27T14:51:58.619Z" } } } } } ] } } }, "/owner/workspaces/{workspaceId}": { "get": { "tags": [ "Owner" ], "summary": "Get owner workspace", "description": "Get owner workspace", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching owner workspace", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update owner workspace", "description": "Update owner workspace", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "disbled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner workspace update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete owner workspace", "description": "Delete owner workspace", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner workspace deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspace" } ] }, "example": { "_id": "c54a858a-b095-4405-9a1c-8567ec91da5e", "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } } }, "/owner/workspaces/{workspaceId}/accountRefs": { "get": { "tags": [ "Owner" ], "summary": "Get all the owner workspace account references", "description": "Get all the owner workspace account references", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "array of owner workspace account references", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PagginatedResponse" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] } } } } ] } }, "example": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ] } } } } ] } }, "post": { "tags": [ "Owner" ], "summary": "Create owner workspace account reference into account data", "description": "Create owner workspace account reference into account data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "nameId" ], "properties": { "nameId": { "type": "string" }, "readAccess": { "type": "boolean" }, "updateAccess": { "type": "boolean" }, "createAccess": { "type": "boolean" }, "deleteAccess": { "type": "boolean" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner workspace account reference creation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } } }, "/owner/workspaces/{workspaceId}/accountRefs/{accountRefId}": { "get": { "tags": [ "Owner" ], "summary": "Get owner workspace account reference", "description": "Get owner workspace account reference", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull fetching owner workspace account reference", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "put": { "tags": [ "Owner" ], "summary": "Update owner workspace account reference", "description": "Update owner workspace account reference", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "readAccess": { "type": "boolean" }, "updateAccess": { "type": "boolean" }, "createAccess": { "type": "boolean" }, "deleteAccess": { "type": "boolean" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner workspace account reference update", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } }, "delete": { "tags": [ "Owner" ], "summary": "Delete owner workspace account reference", "description": "Delete owner workspace account reference", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "accountRefId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "allOf": [ { "$ref": "#/paths/~1roles/get/responses/allOf/0" }, { "200": { "description": "Successfull owner workspace account reference deletion", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] }, "example": { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } } } } } ] } } } }, "security": [ { "BearerAuth": [] } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "Feature": { "type": "object", "required": [ "type", "value" ], "properties": { "name": { "type": "string", "enum": [ "api-route", "ui-route", "ui-module" ], "description": "just a name use to identify the feature", "example": "get feature route" }, "type": { "type": "string", "description": "use to identify type of feature.", "example": "api-route" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "this will be use in UI to categorize the features", "example": [ "Server", "Api Route", "Get" ] }, "value": { "type": "string", "description": "the actual value to use when checking internally in the application", "example": "[GET]_\\api\\v1\\systemInfo" }, "description": { "type": "string" } } }, "Role": { "type": "object", "required": [ "name", "level" ], "properties": { "name": { "type": "string", "description": "a unique human readable identifier for the role", "example": "master" }, "level": { "type": "string", "description": "a unique number to give role a sense of power. The lower the number the greater the power.", "example": 0 }, "reqLimitPerSec": { "type": "number" }, "description": { "type": "string" }, "absoluteAuthority": { "type": "boolean", "description": "if the value is true, all features are accessable to account with this role." }, "featuresRefs": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/RoleFeature" } ] }, "description": "if absoluteAuthority is false then the only accessable feature to account with this role are the features registered here." } }, "example": { "absoluteAuthority": false, "description": "Have access to most of the resources.", "featuresRefs": [ { "_id": "bea762cf-aceb-41ce-b6bf-410ad69ffc9d", "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b", "createdAt": "2023-08-27T14:51:58.605Z", "updatedAt": "2023-08-31T14:34:32.748Z" } ], "level": 1, "name": "Manager" } }, "RoleFeature": { "type": "object", "required": [ "featureId" ], "properties": { "featureId": { "type": "string", "format": "uuid" } }, "example": { "featureId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" } }, "Account": { "type": "object", "required": [ "nameId" ], "properties": { "name": { "type": "string" }, "roleRefs": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountRole" } ] } }, "accountInfos": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountAccountInfo" } ] } }, "passwords": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountPassword" } ] } }, "contactInfos": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountContactInfo" } ] } }, "clientDevices": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountClientDevice" } ] } }, "limitedTransactions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountLimitedTransaction" } ] } }, "disabled": { "type": "boolean" }, "verified": { "type": "boolean" } }, "example": { "clientDevices": [ { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "_id": "ef63156e-c1d8-4547-99be-3ac77fd30d49", "accessTokens": [ { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false, "_id": "b15a3ea0-0783-402d-87dd-319ec519551d", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "contactInfos": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "limitedTransactions": [ { "_id": "5efafc09-a05b-4acd-825d-689675298ae3", "limit": 5, "attempts": 0, "type": "signin", "key": "keytesting", "value": "testing", "expTime": "", "recipient": "app-admin", "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "passwords": [ { "key": "$2b$10$t/6PqNNygfVubx3JvJYFeOD8FsNFKc7RmKSNw58nFQKytLAgy/IEm", "isActive": true, "_id": "6c130316-0168-4ef1-aa91-2beb5a77fc3a", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "rolesRefs": [ { "_id": "bd19863e-3479-47a1-8aeb-4b0f75c03da3", "roleId": "f2b124a8-0452-40f3-b053-c6f3b426e656", "isActive": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "accountInfos": [ { "key": "firstname", "value": "gilbert", "type": "string", "_id": "ac50e922-635c-4c59-817a-59d8d20ecdba", "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "nameId": "master", "verified": true, "disabled": false } }, "AccountRole": { "type": "object", "required": [ "roleId" ], "properties": { "roleId": { "type": "string", "format": "uuid" } }, "example": { "roleId": "3f74c3a5-3200-4c9f-a5c7-077515e1e45b" } }, "AccountAccountInfo": { "type": "object", "required": [ "key", "value", "type" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "example": { "key": "fullname", "value": "Gilbert D. Cuerbo", "type": "string" } }, "AccountAccountConfig": { "type": "object", "required": [ "key", "value", "type" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "example": { "key": "default-workspace", "value": "c54a858a-b095-4405-9a1c-8567ec91da5e", "type": "string" } }, "AccountContactInfo": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "email-address", "mobile-number", "telephone", "app-admin" ] }, "value": { "type": "string" }, "countryCode": { "type": "string" }, "verified": { "type": "boolean" } }, "example": { "type": "email-address", "value": "gilbert.cuerbo@gmail.com", "countryCode": "PH", "verified": false } }, "AccountPassword": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string" }, "expTime": { "type": "date" }, "isActive": { "type": "boolean" } }, "example": { "key": "$2b$10$RK2aY/N7IGG6PeCGEH03puFW8w5AWem3KftDDTyMOx5C0Mqpe9QqG", "expTime": "2023-08-07T03:10:24.423Z", "isActive": true } }, "AccountLimitedTransaction": { "type": "object", "required": [ "limit", "attempts", "type" ], "properties": { "limit": { "type": "number" }, "attempts": { "type": "bumber" }, "type": { "type": "string", "enum": [ "signin", "otp-signin", "forgot-pass", "reset-pass", "verify-contact" ] }, "key": { "type": "string" }, "value": { "type": "string" }, "expTime": { "type": "date" }, "recipient": { "type": "string" }, "disabled": { "type": "boolean" } }, "example": { "limit": 5, "attempts": 0, "type": "reset-pass", "key": 419188, "value": "test", "expTime": "2023-09-08T02:31:09.082Z", "recipient": "app-admin", "disabled": false } }, "AccountClientDevice": { "type": "object", "required": [ "ua" ], "properties": { "ua": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" }, "accessTokens": { "type": "array", "item": { "$ref": "#/components/schemas/AccountClientDeviceAccessToken" } } }, "example": { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", "description": "Test Client Device", "disabled": false, "accessTokens": [] } }, "AccountClientDeviceAccessToken": { "type": "object", "required": [ "jwt" ], "properties": { "jwt": { "type": "string" }, "ipAddress": { "type": "string" }, "expTime": { "type": "date" }, "disabled": { "type": "boolean" } }, "example": { "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIzNzQxMGU3NS0xNzYwLTRiYjYtODVlMC1kMGExMzhkMzc0YmMiLCJpYXQiOjE2OTQyMTg4MTAsImV4cCI6MTY5NDgyMzYxMH0.TRpD4Ia_Z1mLyVebe7xxmwyDjzFGw1LqEHG1d7NDA7A", "ipAddress": "::1", "description": "created when signing in", "expTime": "2023-08-07T03:10:24.423Z", "disabled": false } }, "AccountWorkspace": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "accountRefs": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutoGeneratedData" }, { "$ref": "#/components/schemas/AccountWorkspaceAccountRef" } ] } }, "disabled": { "type": "boolean" } }, "example": { "name": "Test Workspace", "description": "this is just a testing workspace for my personal business", "accountRefs": [ { "_id": "62986e97-cdc0-4454-897a-bd34a8071b1c", "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "disabled": false, "createdAt": "2023-08-27T14:51:58.619Z", "updatedAt": "2023-09-09T00:20:10.686Z" } ], "disabled": false } }, "AccountWorkspaceAccountRef": { "type": "object", "required": [ "accountId" ], "properties": { "accountId": { "type": "string", "format": "uuid" }, "readAccess": { "type": "boolean" }, "updateAccess": { "type": "boolean" }, "createAccess": { "type": "boolean" }, "deleteAccess": { "type": "boolean" }, "accepted": { "type": "boolean" }, "declined": { "type": "boolean" }, "disabled": { "type": "boolean" } }, "example": { "accountId": "c54a858a-b095-4405-9a1c-8567ec91da5e", "readAccess": true, "updateAccess": true, "createAccess": true, "deleteAccess": true, "accepted": true, "declined": false, "disabled": false } }, "Error": { "type": "object", "properties": { "message": { "type": "string" } } }, "AutoGeneratedData": { "type": "object", "properties": { "_id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "example": { "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2023-07-23T11:22:30.886Z", "updatedAt": "2023-07-23T11:22:30.886Z" } }, "PagginatedResponse": { "type": "object", "properties": { "totalItems": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" }, "nextUrl": { "type": "string", "nullable": true } }, "example": { "totalItems": 100, "page": 1, "pageSize": 50, "totalPages": 2, "nextUrl": "api/v1/module?page=2" } } } } }