{ "openapi": "3.0.0", "info": { "title": "ubfidentity", "version": "1.0.0", "description": "UBF Identity", "contact": {} }, "paths": { "/branches/{id}": { "patch": { "x-controller-name": "BranchController", "x-operation-name": "updateById", "tags": [ "BranchController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Branch PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Branch name" } } } } }, "description": "Request body for Branch save", "required": true, "x-parameter-index": 1 }, "operationId": "BranchController.updateById" }, "get": { "x-controller-name": "BranchController", "x-operation-name": "findById", "tags": [ "BranchController" ], "responses": { "200": { "description": "BranchResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BranchController.findById" }, "delete": { "x-controller-name": "BranchController", "x-operation-name": "deleteById", "tags": [ "BranchController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Branch DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BranchController.deleteById" } }, "/branches": { "post": { "x-controller-name": "BranchController", "x-operation-name": "create", "tags": [ "BranchController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Branch name" } } } } }, "description": "Request body for Branch save", "required": true }, "operationId": "BranchController.create" }, "get": { "x-controller-name": "BranchController", "x-operation-name": "find", "tags": [ "BranchController" ], "responses": { "200": { "description": "BranchsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "BranchsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "BranchController.find" } }, "/generatetoken": { "get": { "x-controller-name": "UserController", "x-operation-name": "generatetoken", "tags": [ "UserController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": {} } } } } }, "operationId": "UserController.generatetoken" } }, "/migrate/user-fromjson": { "get": { "x-controller-name": "MigrateController", "x-operation-name": "migrateUserFromJson", "tags": [ "MigrateController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "operationId": "MigrateController.migrateUserFromJson" } }, "/migrate/user-fromjson-test": { "get": { "x-controller-name": "MigrateController", "x-operation-name": "migrateUserFromJsonTest", "tags": [ "MigrateController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "operationId": "MigrateController.migrateUserFromJsonTest" } }, "/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/roles/{id}": { "patch": { "x-controller-name": "RoleController", "x-operation-name": "updateById", "tags": [ "RoleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Role PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Role name" }, "permissions": { "type": "array", "items": { "type": "object" }, "description": "Permissions array" }, "filters": { "type": "object", "description": "Filters" } } } } }, "description": "Request body for Role save", "required": true, "x-parameter-index": 1 }, "operationId": "RoleController.updateById" }, "get": { "x-controller-name": "RoleController", "x-operation-name": "findById", "tags": [ "RoleController" ], "responses": { "200": { "description": "RoleResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleController.findById" }, "delete": { "x-controller-name": "RoleController", "x-operation-name": "deleteById", "tags": [ "RoleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Role DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleController.deleteById" } }, "/roles": { "post": { "x-controller-name": "RoleController", "x-operation-name": "create", "tags": [ "RoleController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Role name" }, "permissions": { "type": "array", "items": { "type": "object" }, "description": "Permissions array" }, "filters": { "type": "object", "description": "Filters" } } } } }, "description": "Request body for Role save", "required": true }, "operationId": "RoleController.create" }, "get": { "x-controller-name": "RoleController", "x-operation-name": "find", "tags": [ "RoleController" ], "responses": { "200": { "description": "RolesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "RolesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "RoleController.find" } }, "/users/add": { "post": { "x-controller-name": "UserController", "x-operation-name": "addUser", "tags": [ "UserController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName", "lastName", "email", "password", "confirmPassword", "roleId", "branchIds" ], "properties": { "firstName": { "type": "string", "description": "User first name." }, "lastName": { "type": "string", "description": "User last name." }, "email": { "type": "string", "description": "Email address for a user.", "jsonSchema": { "format": "email", "transform": [ "toLowerCase" ], "errorMessage": "Email should be valid." } }, "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" }, "branchIds": { "type": "array", "items": { "type": "number" }, "description": "Branch of the user. Possible values are 1 = New Zealand,2 = Australia,3 = Fiji" }, "permissions": { "type": "array", "items": { "type": "object" }, "description": "Permissions array" }, "filters": { "type": "object", "description": "Filters" } } } } }, "description": "User AddUser request body", "required": true }, "operationId": "UserController.addUser" } }, "/users/change-password": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changePassword", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "password", "confirmPassword" ], "properties": { "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } } } } } }, "description": "Change password request body", "required": true }, "operationId": "UserController.changePassword" } }, "/users/change-role": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeRole", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change role success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "roleId" ], "properties": { "id": { "type": "number" }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" } } } } }, "description": "Change role request body", "required": true }, "operationId": "UserController.changeRole" } }, "/users/change-status": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeStatus", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "number" }, "status": { "type": "number", "description": " Possible values are 0 = Deactive, 1 = Active,2 = Delete" } } } } }, "description": "Change status request body", "required": true }, "operationId": "UserController.changeStatus" } }, "/users/initiate-ms-auth": { "get": { "x-controller-name": "UserController", "x-operation-name": "initiateMsAuth", "tags": [ "UserController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "authLink": { "type": "string" } } } } } } }, "parameters": [ { "name": "redirectUri", "in": "query", "schema": { "type": "string" } } ], "operationId": "UserController.initiateMsAuth" } }, "/users/login": { "post": { "x-controller-name": "UserController", "x-operation-name": "login", "tags": [ "UserController" ], "responses": { "200": { "description": "LoginResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 } } } } }, "description": "The input of login function", "required": true }, "operationId": "UserController.login" } }, "/users/me": { "get": { "x-controller-name": "UserController", "x-operation-name": "me", "tags": [ "UserController" ], "responses": { "200": { "description": "UserResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "operationId": "UserController.me" } }, "/users/ms/login": { "post": { "x-controller-name": "UserController", "x-operation-name": "MSLogin", "tags": [ "UserController" ], "responses": { "200": { "description": "MSLoginResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MSLoginResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "redirectUri": { "type": "string" } } } } }, "description": "The input of login function", "required": true }, "operationId": "UserController.MSLogin" } }, "/users/ms/me": { "post": { "x-controller-name": "UserController", "x-operation-name": "MSMe", "tags": [ "UserController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": {} } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "msAccessToken": { "type": "string" } } } } }, "description": "The input of Me function", "required": true }, "operationId": "UserController.MSMe" } }, "/users/{id}/change-password": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeUserPassword", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "password", "confirmPassword" ], "properties": { "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } } } } } }, "description": "Change password request body", "required": true, "x-parameter-index": 1 }, "operationId": "UserController.changeUserPassword" } }, "/users/{id}": { "patch": { "x-controller-name": "UserController", "x-operation-name": "updateById", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Users PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName", "lastName", "roleId", "branchIds" ], "properties": { "firstName": { "type": "string", "description": "User first name." }, "lastName": { "type": "string", "description": "User last name." }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" }, "status": { "type": "number", "description": "Status" }, "branchIds": { "type": "array", "items": { "type": "number" }, "description": "Branch of the user. Possible values are 1 = New Zealand,2 = Australia,3 = Fiji" }, "permissions": { "type": "array", "items": { "type": "object" }, "description": "Permissions array" }, "filters": { "type": "object", "description": "Filters" } } } } }, "description": "Request body for basic details update", "required": true, "x-parameter-index": 1 }, "operationId": "UserController.updateById" }, "get": { "x-controller-name": "UserController", "x-operation-name": "findById", "tags": [ "UserController" ], "responses": { "200": { "description": "UserResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserController.findById" } }, "/users": { "get": { "x-controller-name": "UserController", "x-operation-name": "find", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } } ], "operationId": "UserController.find" } } }, "servers": [ { "url": "https://identity.ubfreight.com" } ], "components": { "schemas": { "BranchResponse": { "type": "object", "title": "BranchResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "PingResponse": { "type": "object", "title": "PingResponse", "properties": { "greeting": { "type": "string" }, "date": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } }, "additionalProperties": true } } }, "RoleResponse": { "type": "object", "title": "RoleResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "LoginResponse": { "type": "object", "title": "LoginResponse", "properties": { "token": { "type": "string" } } }, "UserResponse": { "type": "object", "title": "UserResponse", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } }, "MSLoginResponse": { "type": "object", "title": "MSLoginResponse", "properties": { "token": { "type": "string" }, "mscAccessToken": { "type": "string" } } } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [] }