{ "openapi": "3.0.0", "info": { "title": "Nacview", "description": "Documentation of API", "version": "v3.1.82" }, "servers": [ { "url": "https://uat-api.nacview.com/", "description": "API over HTTP" } ], "paths": { "/api/v3/{resource}/batch": { "put": { "tags": [ "Action Groups" ], "summary": "An endpoint for updating main entity in action groups", "operationId": "put_app_groupactions_port_groupactions_resource", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to action groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupActionsRequest" } } } }, "responses": { "201": { "description": "Configuration updated correctly" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Action Groups" ], "summary": "An endpoint for delete action groups", "operationId": "delete_app_groupactions_port_groupactions_delete", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to action groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveGroupActionsRequest" } } } }, "responses": { "201": { "description": "Configuration updated correctly" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/{resource}/{id}/{subresource}/batch": { "put": { "tags": [ "Action Groups" ], "summary": "An endpoint for updating children of entity in action groups", "operationId": "put_app_groupactions_port_groupactions_subresource", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "subresource", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to action groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupActionsRequest" } } } }, "responses": { "201": { "description": "Configuration updated correctly" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Action Groups" ], "summary": "An endpoint for delete action groups", "operationId": "delete_app_groupactions_port_groupactions_delete_1", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "subresource", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to action groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveGroupActionsRequest" } } } }, "responses": { "201": { "description": "Configuration updated correctly" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/{resourceRoute}/{resourceRouteId}/archive/{uid}": { "get": { "tags": [ "Archive" ], "summary": "An endpoint to view archives of entity.", "operationId": "get_app_archive_port_http_query_archivequery_view", "parameters": [ { "name": "resourceRoute", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "vlan", "wifi-network", "subnetwork", "dhcp-option", "endpoint-device", "endpoint-device-parameter", "event-definition", "indexes", "matrix-policy", "matrix-policy-category", "matrix-policy-option", "matrix-policy-profile-action", "matrix-policy-time", "nacview-assistant", "nacview-scout", "system-license", "dhcp-whitelist", "ip-address", "pki", "user", "authorization-server", "integration-server", "ldap-service", "ldap-service-system-node-parameter", "tacacs-server", "printable-template", "notification-template", "object-group", "mac-address", "identity-voucher", "identity-common", "identity-external", "identity", "color-identifier", "organization-unit", "device-credential", "object-certificate", "access-group", "notification-channel", "captive-portal", "captive-portal-sponsor", "captive-portal-registration-form", "captive-portal-object-group-config", "system-node", "system-node-firewall", "network-device", "vrrp-system-node", "reauth-device-credential", "sector", "profiling-definition", "port", "archive", "notification", "events-dhcp", "events-accounting", "events-tacacs", "events-otp", "events-snmptrap", "events-msevents", "events-syslog", "events-authorize", "system-node-routing" ] } }, { "name": "resourceRouteId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns archive view.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ViewArchiveResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/archive/{uid}": { "get": { "tags": [ "Archive" ], "summary": "An endpoint to view archive data for full access admin", "operationId": "get_app_archive_port_http_query_archivequery_viewadmin", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns archive view.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ViewArchiveResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/{resourceRoute}/{resourceRouteId}/archive/list": { "post": { "tags": [ "Archive" ], "summary": "An endpoint to view archives of entity.", "operationId": "post_app_archive_port_http_query_archivequery_list", "parameters": [ { "name": "resourceRoute", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "vlan", "wifi-network", "subnetwork", "dhcp-option", "endpoint-device", "endpoint-device-parameter", "event-definition", "indexes", "matrix-policy", "matrix-policy-category", "matrix-policy-option", "matrix-policy-profile-action", "matrix-policy-time", "nacview-assistant", "nacview-scout", "system-license", "dhcp-whitelist", "ip-address", "pki", "user", "authorization-server", "integration-server", "ldap-service", "ldap-service-system-node-parameter", "tacacs-server", "printable-template", "notification-template", "object-group", "mac-address", "identity-voucher", "identity-common", "identity-external", "identity", "color-identifier", "organization-unit", "device-credential", "object-certificate", "access-group", "notification-channel", "captive-portal", "captive-portal-sponsor", "captive-portal-registration-form", "captive-portal-object-group-config", "system-node", "system-node-firewall", "network-device", "vrrp-system-node", "reauth-device-credential", "sector", "profiling-definition", "port", "archive", "notification", "events-dhcp", "events-accounting", "events-tacacs", "events-otp", "events-snmptrap", "events-msevents", "events-syslog", "events-authorize", "system-node-routing" ] } }, { "name": "resourceRouteId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object of archive data.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns archive view.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListArchiveResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/archive/list": { "post": { "tags": [ "Archive" ], "summary": "An endpoint to list archives of entity for full access admin.", "operationId": "post_app_archive_port_http_query_archivequery_listadmin", "requestBody": { "description": "JSON object of archive data.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns archive view.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListArchiveResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/auth-check": { "get": { "summary": "An endpoint to check authentication state", "operationId": "get_app_shared_port_http_authhealthcheck_health", "responses": { "200": { "description": "Successful authentication check" } } } }, "/api/v3/config/global-configuration": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Global Configuration details.", "operationId": "get_app_shared_port_http_query_globalconfiguration_globalconfigurationquery_view", "responses": { "200": { "description": "View Global Configuration object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewGlobalConfigurationResponse" } } } }, "404": { "description": "GlobalConfiguration not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Global Configuration", "operationId": "put_app_shared_port_http_command_globalconfiguration_globalconfigurationcommand_update", "requestBody": { "description": "Request to update an Global Configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalConfigurationRequest" } } } }, "responses": { "204": { "description": "Global Configuration updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/{resourceRoute}/{id}/change-state": { "put": { "tags": [ "State Manager" ], "summary": "The endpoint for activating or deactivating an entity object.", "operationId": "put_app_shared_port_http_command_objectenablestate_activitystatus_changestate", "parameters": [ { "name": "resourceRoute", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "user", "ldap-service", "tacacs-server", "printable-template", "color-identifier", "wifi-network", "notification-template", "organization-unit", "pki", "device-credential", "object-group", "identity-voucher", "identity-common", "identity-external", "integration-server", "vlan", "access-group", "notification-channel", "subnetwork", "dhcp-option", "captive-portal", "sector", "profiling-definition", "port", "system-node-firewall", "mac-address", "authorization-server", "object-certificate", "indexes", "matrix-policy", "matrix-policy-rule", "matrix-policy-category", "ldap-service-system-node-parameter", "captive-portal-registration-form", "network-device", "captive-portal-sponsor", "endpoint-device", "captive-portal-object-group-config", "dhcp-whitelist", "endpoint-device-parameter", "ip-address", "dhcp-option-item", "nacview-scout-object-group-config", "system-node-interface", "tacacs-server-custom-parameter", "tacacs-server-settings", "nacview-assistant" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Object has been updated successfully" }, "409": { "description": "Object is built in or protected" }, "404": { "description": "Not found object with given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/{parentResourceRoute}/{parentResourceId}/{childResourceRoute}/{childResourceId}/change-state": { "put": { "tags": [ "State Manager" ], "summary": "The endpoint for activating or deactivating an child entity object.", "operationId": "put_app_shared_port_http_command_objectenablestate_activitystatus_changechildstate", "parameters": [ { "name": "parentResourceRoute", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "dhcp-option", "nacview-scout", "system-node", "tacacs-server" ] } }, { "name": "childResourceRoute", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "dhcp-option-item", "nacview-scout-object-group-config", "system-node-interface", "tacacs-server-custom-parameter", "tacacs-server-settings", "ldap-service-referral" ] } }, { "name": "parentResourceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "childResourceId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Object has been updated successfully" }, "409": { "description": "Object is built in or protected" }, "404": { "description": "Not found object with given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/app/exception-message": { "get": { "tags": [ "Exception Message Codes" ], "summary": "An endpoint to fetch all exception message codes", "operationId": "get_app_shared_port_http_exceptionmessage_fetch", "responses": { "200": { "description": "List of exception message codes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllExceptionMessageCodesResponse" } } } } } } }, "/api/v3/nacview-assistant": { "post": { "tags": [ "Nacview Assistant" ], "summary": "An endpoint to create a new Nacview Assistant.", "operationId": "post_app_adminaccounting_port_http_command_nacviewassistant_nacviewassistant_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NacviewAssistantRequest" } } } }, "responses": { "201": { "description": "Nacview Assistant has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-assistant/{id}": { "get": { "tags": [ "Nacview Assistant" ], "summary": "An endpoint to retrieve Nacview Assistant details.", "operationId": "get_app_adminaccounting_port_http_query_nacviewassistant_nacviewassistantquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Nacview Assistant object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNacviewAssistantResponse" } } } }, "404": { "description": "Not found Nacview Assistant" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Nacview Assistant" ], "summary": "An endpoint to update an existing Nacview Assistant.", "operationId": "put_app_adminaccounting_port_http_command_nacviewassistant_nacviewassistant_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NacviewAssistantRequest" } } } }, "responses": { "204": { "description": "Nacview Assistant has been updated" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Nacview Assistant" ], "summary": "An endpoint to delete Nacview Assistant.", "operationId": "delete_app_adminaccounting_port_http_command_nacviewassistant_nacviewassistant_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Nacview Assistant has been deleted" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/password-configuration": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to view Password Configuration", "operationId": "get_app_adminaccounting_port_http_query_passwordconfiguration_viewpasswordconfiguration_index", "responses": { "200": { "description": "The running password configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewPasswordConfigurationResponse" } } } }, "500": { "description": "The running password configuration not found.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Running Password Configuration not found!" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Password Configuration", "operationId": "put_app_adminaccounting_port_http_command_passwordconfiguration_updatepasswordconfiguration_index", "requestBody": { "description": "Request to update Password Configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePasswordConfigurationRequest" } } } }, "responses": { "204": { "description": "Configuration updated correctly" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/{id}": { "get": { "tags": [ "User" ], "summary": "An endpoint to get an existing User.", "operationId": "get_app_adminaccounting_port_http_query_user_userquery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the result of the User data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewUserResponse" } } } }, "404": { "description": "User not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "User" ], "summary": "An endpoint to update a User.", "operationId": "put_app_adminaccounting_port_http_command_user_usercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to update a User.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditUserRequest" } } } }, "responses": { "204": { "description": "User has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "User not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "User" ], "summary": "An endpoint to delete an existing User.", "operationId": "delete_app_adminaccounting_port_http_command_user_usercommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "User has been deleted" }, "404": { "description": "User not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user": { "post": { "tags": [ "User" ], "summary": "An endpoint to create a new User.", "operationId": "post_app_adminaccounting_port_http_command_user_usercommand_create", "requestBody": { "description": "JSON object containing data to create a new User.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserRequest" } } } }, "responses": { "201": { "description": "User has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/me/preferences": { "get": { "tags": [ "User" ], "summary": "Returns basic information about the currently authenticated user", "operationId": "get_app_adminaccounting_port_http_query_user_userquery_getcurrentpreferences", "responses": { "200": { "description": "Returns the short result of the User data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreferencesUserResponse" } } } }, "404": { "description": "Preferences not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "post": { "tags": [ "User" ], "summary": "Endpoint creates custom user settings", "operationId": "post_app_adminaccounting_port_http_command_user_usercommand_preferences", "requestBody": { "description": "JSON object containing data to create a new User.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesRequest" } } } }, "responses": { "201": { "description": "User has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/password/setting": { "get": { "tags": [ "User" ], "summary": "An endpoint to fetch administrator configuration passwords", "operationId": "get_app_adminaccounting_port_http_query_user_userquery_setuppassword", "responses": { "200": { "description": "Returns the administrator configuration password. After entering the password correctly", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewUserPasswordTacacsSettingsResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "User" ], "summary": "An endpoint to update administrator configuration passwords", "operationId": "put_app_adminaccounting_port_http_command_user_usercommand_setuppassword", "requestBody": { "description": "JSON object containing data to update a User.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSecuritySetting" } } } }, "responses": { "204": { "description": "User has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "User not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/{id}/mfa/refresh": { "patch": { "tags": [ "User" ], "summary": "An endpoint to refresh mfa secret", "operationId": "patch_app_adminaccounting_port_http_command_user_usercommand_refreshmfa", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to refresh mfa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRefreshMfaRequest" } } } }, "responses": { "204": { "description": "Mfa secret has been refreshed" }, "404": { "description": "User not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/mfa/refresh": { "patch": { "tags": [ "User" ], "summary": "An endpoint to refresh mfa secret", "operationId": "patch_app_adminaccounting_port_http_command_user_usercommand_refreshmfa_1", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to refresh mfa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRefreshMfaRequest" } } } }, "responses": { "204": { "description": "Mfa secret has been refreshed" }, "404": { "description": "User not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/logout": { "delete": { "tags": [ "User" ], "summary": "An endpoint to logout user.", "operationId": "delete_app_adminaccounting_port_http_command_user_usercommand_logout", "responses": { "204": { "description": "User has been logged out" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-assistant/{id}/configuration-files/file": { "patch": { "tags": [ "Nacview Assistant" ], "summary": "An endpoint to view configuration file.", "operationId": "patch_app_adminaccounting_port_http_query_nacviewassistant_nacviewassistantfile_file", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NacviewAssistantConfigurationRequest" } } } }, "responses": { "200": { "description": "Single configuration file", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not found Nacview Assistant" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-assistant/list": { "post": { "tags": [ "Nacview Assistant" ], "summary": "An endpoint to build and search Nacview Assistant table.", "operationId": "post_app_adminaccounting_port_http_query_nacviewassistant_nacviewassistantquery_list", "requestBody": { "description": "JSON object containing data to search for Nacview Assistant.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Nacview Assistant search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListNacviewAssistantResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-assistant/mini-list": { "post": { "tags": [ "Nacview Assistant" ], "summary": "Endpoint for searching the mini list of Nacview Assistant.", "operationId": "post_app_adminaccounting_port_http_query_nacviewassistant_nacviewassistantquery_minilist", "requestBody": { "description": "JSON object containing data to search for Nacview Assistant.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Nacview Assistant search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListNacviewAssistantResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-assistant/{id}/configuration-files/available-files": { "patch": { "tags": [ "Nacview Assistant" ], "summary": "An endpoint to view available configuration files.", "operationId": "patch_app_adminaccounting_port_http_query_nacviewassistant_nacviewassistantquery_availablefiles", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Result of available files query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableFilesResponse" } } } }, "404": { "description": "Not found Nacview Assistant" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/resource-route": { "get": { "tags": [ "Access Group" ], "summary": "An endpoint to fetch all available resource routes.", "operationId": "get_app_adminaccounting_port_http_query_resourceroute_resourceroutelist_index", "responses": { "200": { "description": "Returns the result of the fetching.", "content": { "application/json": { "schema": { "properties": { "data": { "description": "An array of Resource Routes.", "type": "array", "items": { "$ref": "#/components/schemas/ListResourceRoutesResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/{id}/mfa/generate-qr/{type}": { "patch": { "tags": [ "User" ], "summary": "An endpoint to generate Google secret QR code", "operationId": "patch_app_adminaccounting_port_http_query_user_userfilequery_generateqr", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "nacview", "google" ] } } ], "responses": { "404": { "description": "User not found by given id" }, "200": { "description": "Single QR image", "content": { "application/png": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/mfa/generate-qr/{type}": { "patch": { "tags": [ "User" ], "summary": "An endpoint to generate Google secret QR code", "operationId": "patch_app_adminaccounting_port_http_query_user_userfilequery_generateqr_1", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "nacview", "google" ] } } ], "responses": { "404": { "description": "User not found by given id" }, "200": { "description": "Single QR image", "content": { "application/png": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/list": { "post": { "tags": [ "User" ], "summary": "An endpoint to build and search User table.", "operationId": "post_app_adminaccounting_port_http_query_user_userquery_list", "requestBody": { "description": "JSON object containing data to search for Users.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListUserResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/mini-list": { "post": { "tags": [ "User" ], "summary": "An endpoint to list base information about Users.", "operationId": "post_app_adminaccounting_port_http_query_user_userquery_minilist", "requestBody": { "description": "JSON object containing data to search for Users.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns representation fields for search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListUserResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/me": { "get": { "tags": [ "User" ], "summary": "Returns basic information about the currently authenticated user", "operationId": "get_app_adminaccounting_port_http_query_user_userquery_getcurrentuser", "responses": { "200": { "description": "Returns the short result of the User data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentUserSettingsResponse" } } } }, "404": { "description": "User not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/app/reset-password/request": { "post": { "tags": [ "Reset password" ], "summary": "An endpoint to request reset password token.", "operationId": "post_app_adminaccounting_port_http_command_user_resetpassword_resetpasswordrequest", "requestBody": { "description": "Request to update Password Configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordTokenRequest" } } } }, "responses": { "201": { "description": "A new reset password token generated!", "content": { "application/json": { "schema": { "properties": { "csrf": { "description": "CSRF token for authenticating the creation of a new password", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } }, "type": "object" } } } }, "400": { "description": "Bad request" } } } }, "/app/reset-password/confirm": { "post": { "tags": [ "Reset password" ], "summary": "An endpoint to set a new password.", "operationId": "post_app_adminaccounting_port_http_command_user_resetpassword_newpassword", "requestBody": { "description": "Request to set a new password", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPasswordRequest" } } } }, "responses": { "204": { "description": "A password successfully updated!" }, "401": { "description": "Invalid reset password credentials." } } } }, "/app/login": { "post": { "tags": [ "Login" ], "summary": "The endpoint to authenticate user.", "operationId": "post_share", "requestBody": { "content": { "application/json": { "schema": { "properties": { "username": { "type": "string", "example": "nvadmin" }, "password": { "type": "string", "example": "NACVIEW" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful authentication", "content": { "application/json": { "schema": { "properties": { "token": { "type": "string", "example": "jwt token" } }, "type": "object" } } } }, "206": { "description": "Need MFA token to finish authentication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaRequiredForLoginResponse" } } } }, "400": { "description": "Incorrect data" }, "401": { "description": "Incorrect password or username" } } } }, "/app/login/mfa": { "post": { "tags": [ "Login" ], "summary": "An endpoint to validate an MFA token", "operationId": "post_mfa", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaAuthenticationRequest" } } } }, "responses": { "200": { "description": "Successful authentication", "content": { "application/json": { "schema": { "properties": { "token": { "type": "string", "example": "jwt token" } }, "type": "object" } } } }, "400": { "description": "Incorrect payload" }, "401": { "description": "Incorrect MFA token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CsrfMessageResponse" } } } }, "403": { "description": "Invalid MFA session token, start from beginning" } } } }, "/app/login/send-token": { "post": { "tags": [ "Login" ], "summary": "An endpoint that sends an MFA token to the user", "operationId": "post_send_mfa_token", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMfaAuthenticationTokenRequest" } } } }, "responses": { "200": { "description": "MFA token successfully sent to the user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CsrfMessageResponse" } } } }, "400": { "description": "Incorrect payload" }, "403": { "description": "Invalid MFA session token, start from beginning" } } } }, "/app/permissions": { "get": { "tags": [ "User Access" ], "summary": "An endpoint to retrieve user permissions for routes", "operationId": "get_permissions", "responses": { "200": { "description": "Response for user with specific permissions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListUserAccessToRouteResponse" } }, "example": [ { "name": "vlan", "methods": [ "CREATE", "EDIT", "DELETE", "VIEW", "LIST", "CUSTOM" ] }, { "name": "wifi-network", "methods": [ "VIEW", "LIST" ] } ] } } }, "204": { "description": "Response for a user with all permissions (super admin)" } } } }, "/api/v3/access-group": { "post": { "tags": [ "Access Group" ], "summary": "An endpoint to create a new AccessGroup.", "operationId": "post_app_accesscontrol_port_http_command_accessgroupcommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessGroupRequest" } } } }, "responses": { "201": { "description": "AccessGroup created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/access-group/{id}": { "get": { "tags": [ "Access Group" ], "summary": "An endpoint to retrieve AccessGroup details.", "operationId": "get_app_accesscontrol_port_http_query_accessgroupquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Returns the result of the AccessGroup data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAccessGroupResponse" } } } }, "404": { "description": "AccessGroup not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Access Group" ], "summary": "An endpoint to update an AccessGroup.", "operationId": "put_app_accesscontrol_port_http_command_accessgroupcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessGroupRequest" } } } }, "responses": { "200": { "description": "AccessGroup updated" }, "400": { "description": "Incorrect update payload" }, "404": { "description": "AccessGroup not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Access Group" ], "summary": "An endpoint to delete an existing AccessGroup.", "operationId": "delete_app_accesscontrol_port_http_command_accessgroupcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "AccessGroup deleted" }, "404": { "description": "AccessGroup not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/access-group/list": { "post": { "tags": [ "Access Group" ], "summary": "An endpoint to build and search AccessGroup table.", "operationId": "post_app_accesscontrol_port_http_query_accessgroupquery_list", "requestBody": { "description": "JSON object containing data to search for Access Groups.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListAccessGroupResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/access-group/mini-list": { "post": { "tags": [ "Access Group" ], "summary": "An endpoint to search AccessGroup list with basic properties.", "operationId": "post_app_accesscontrol_port_http_query_accessgroupquery_minilist", "requestBody": { "description": "JSON object containing data to search for Access Groups.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/permissions": { "get": { "tags": [ "User Access" ], "summary": "An endpoint to retrieve user permissions for routes", "operationId": "get_app_accesscontrol_port_http_query_listofuseraccess_index", "responses": { "200": { "description": "Response for user with specific permissions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListUserAccessToRouteResponse" } }, "example": [ { "name": "vlan", "methods": [ "CREATE", "EDIT", "DELETE", "VIEW", "LIST", "CUSTOM" ] }, { "name": "wifi-network", "methods": [ "VIEW", "LIST" ] } ] } } }, "204": { "description": "Response for a user with all permissions (super admin)" } } } }, "/api/v3/matrix-policy": { "post": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to create a new matrix policy.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicy_matrixpolicycommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyRequest" } } } }, "responses": { "201": { "description": "Matrix Policy has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{id}": { "get": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to retrieve Matrix Policy details.", "operationId": "get_app_accesspolicy_port_http_query_matrixpolicy_matrixpolicyquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a single Matrix Policy object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMatrixPolicyResponse" } } } }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to update an existing Matrix Policy.", "operationId": "put_app_accesspolicy_port_http_command_matrixpolicy_matrixpolicycommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyRequest" } } } }, "responses": { "204": { "description": "Matrix Policy has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to delete an existing Matrix Policy.", "operationId": "delete_app_accesspolicy_port_http_command_matrixpolicy_matrixpolicycommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy has been deleted" }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{id}/install": { "patch": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to install selected list.", "operationId": "patch_app_accesspolicy_port_http_command_matrixpolicy_matrixpolicycommand_install", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy has been installed" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{id}/restore": { "patch": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to restore selected list.", "operationId": "patch_app_accesspolicy_port_http_command_matrixpolicy_matrixpolicycommand_restore", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy has been restored" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{id}/clone": { "post": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to clone an existing Matrix Policy.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicy_matrixpolicycommand_clone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneMatrixPolicyRequest" } } } }, "responses": { "204": { "description": "Matrix Policy has been cloned" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{id}/reorder": { "patch": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to reorder selected list.", "operationId": "patch_app_accesspolicy_port_http_command_matrixpolicy_matrixpolicycommand_reorder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to change sequencer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderMatrixPolicyRequest" } } } }, "responses": { "204": { "description": "Matrix Policy has been reordered" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy or requested wrong rules count" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-category": { "post": { "tags": [ "Matrix Policy Category" ], "summary": "An endpoint to create a new Matrix Policy Category.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicycategory_matrixpolicycategorycommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyCategoryRequest" } } } }, "responses": { "201": { "description": "Matrix Policy Category has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-category/{id}": { "get": { "tags": [ "Matrix Policy Category" ], "summary": "An endpoint to retrieve Matrix Policy Category details.", "operationId": "get_app_accesspolicy_port_http_query_matrixpolicyquery_matrixpolicycategoryquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Matrix Policy Category object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMatrixPolicyCategoryResponse" } } } }, "404": { "description": "Matrix Policy Category not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Matrix Policy Category" ], "summary": "An endpoint to update an existing Matrix Policy Category.", "operationId": "put_app_accesspolicy_port_http_command_matrixpolicycategory_matrixpolicycategorycommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyCategoryRequest" } } } }, "responses": { "204": { "description": "Matrix Policy Category has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy Category" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Matrix Policy Category" ], "summary": "An endpoint to delete an existing Matrix Policy Category.", "operationId": "delete_app_accesspolicy_port_http_command_matrixpolicycategory_matrixpolicycategorycommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy Category has been deleted" }, "404": { "description": "Not found Matrix Policy Category" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option": { "post": { "tags": [ "Matrix Policy Option" ], "summary": "An endpoint to create a new Matrix Policy Option.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicyoption_matrixpolicyoptioncommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyOptionRequest" } } } }, "responses": { "201": { "description": "Matrix Policy Option has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option/{id}": { "get": { "tags": [ "Matrix Policy Option" ], "summary": "An endpoint to retrieve Matrix Policy Option details.", "operationId": "get_app_accesspolicy_port_http_query_matrixpolicyoption_matrixpolicyoptionquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Matrix Policy Option object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMatrixPolicyOptionResponse" } } } }, "404": { "description": "Matrix Policy Option not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Matrix Policy Option" ], "summary": "An endpoint to update an existing Matrix Policy Option.", "operationId": "put_app_accesspolicy_port_http_command_matrixpolicyoption_matrixpolicyoptioncommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyOptionRequest" } } } }, "responses": { "204": { "description": "Matrix Policy Option has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy Option" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Matrix Policy Option" ], "summary": "An endpoint to delete an existing Matrix Policy Option.", "operationId": "delete_app_accesspolicy_port_http_command_matrixpolicyoption_matrixpolicyoptioncommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy Option has been deleted" }, "404": { "description": "Matrix Policy Option not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option/{matrixPolicyOptionId}/matrix-policy-option-item": { "post": { "tags": [ "Matrix Policy Option Item" ], "summary": "An endpoint to create a new Matrix Policy Option Item.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicyoptionitem_matrixpolicyoptionitemcommand_create", "parameters": [ { "name": "matrixPolicyOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyOptionItemRequest" } } } }, "responses": { "201": { "description": "Matrix Policy Option Item has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option/{matrixPolicyOptionId}/matrix-policy-option-item/{id}": { "get": { "tags": [ "Matrix Policy Option Item" ], "summary": "An endpoint to retrieve Matrix Policy Option Item.", "operationId": "get_app_accesspolicy_port_http_query_matrixpolicyoption_matrixpolicyoptionitemquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "matrixPolicyOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Single Matrix Policy Option Item object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMatrixPolicyOptionItemResponse" } } } }, "404": { "description": "Matrix Policy Option Item not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Matrix Policy Option Item" ], "summary": "An endpoint to update an existing Matrix Policy Option Item.", "operationId": "put_app_accesspolicy_port_http_command_matrixpolicyoptionitem_matrixpolicyoptionitemcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "matrixPolicyOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyOptionItemRequest" } } } }, "responses": { "204": { "description": "Matrix Policy Option Item has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy Option Item" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Matrix Policy Option Item" ], "summary": "An endpoint to delete an existing Matrix Policy Option Item.", "operationId": "delete_app_accesspolicy_port_http_command_matrixpolicyoptionitem_matrixpolicyoptionitemcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "matrixPolicyOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Matrix Policy Option Item has been deleted" }, "404": { "description": "Not found Matrix Policy Option Item" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-profile-action": { "post": { "tags": [ "Matrix Policy Profile Action" ], "summary": "An endpoint to create a new Matrix Policy Profile Action.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicyprofileaction_matrixpolicyprofileactioncommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyProfileActionRequest" } } } }, "responses": { "201": { "description": "Matrix Policy Profile Action has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-profile-action/{id}": { "get": { "tags": [ "Matrix Policy Profile Action" ], "summary": "An endpoint to retrieve Matrix Policy Profile Action details.", "operationId": "get_app_accesspolicy_port_http_query_matrixpolicyprofileaction_matrixpolicyprofileactionquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Matrix Policy Profile Action object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMatrixPolicyProfileActionResponse" } } } }, "404": { "description": "Matrix Policy Profile Action not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Matrix Policy Profile Action" ], "summary": "An endpoint to update an existing Matrix Policy Profile Action.", "operationId": "put_app_accesspolicy_port_http_command_matrixpolicyprofileaction_matrixpolicyprofileactioncommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyProfileActionRequest" } } } }, "responses": { "204": { "description": "Matrix Policy Profile Action option has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Matrix Policy Profile Action" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Matrix Policy Profile Action" ], "summary": "An endpoint to delete an existing Matrix Policy Profile Action.", "operationId": "delete_app_accesspolicy_port_http_command_matrixpolicyprofileaction_matrixpolicyprofileactioncommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy Profile Action has been deleted" }, "404": { "description": "Matrix Policy Profile Action not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{matrixPolicyId}/matrix-policy-rule": { "post": { "tags": [ "Matrix Policy Rule" ], "summary": "An endpoint to create a new Matrix Policy Rule.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicyrule_matrixpolicyrulecommand_create", "parameters": [ { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMatrixPolicyRuleRequest" } } } }, "responses": { "201": { "description": "Matrix Policy Rule has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{matrixPolicyId}/matrix-policy-rule/{id}": { "get": { "tags": [ "Matrix Policy Rule" ], "summary": "An endpoint to retrieve Matrix Policy Rule details.", "operationId": "get_app_accesspolicy_port_http_query_matrixpolicyrule_matrixpolicyrulequery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "return single Matrix Policy Rule object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMatrixPolicyRuleResponse" } } } }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Matrix Policy Rule" ], "summary": "An endpoint to update an existing Matrix Policy Rule.", "operationId": "put_app_accesspolicy_port_http_command_matrixpolicyrule_matrixpolicyrulecommand_edit", "parameters": [ { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMatrixPolicyRuleRequest" } } } }, "responses": { "204": { "description": "Matrix Policy Rule has been updated" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Matrix Policy Rule" ], "summary": "An endpoint to soft delete Matrix Policy Rule.", "operationId": "delete_app_accesspolicy_port_http_command_matrixpolicyrule_matrixpolicyrulecommand_delete", "parameters": [ { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy Rule has been deleted" }, "404": { "description": "Matrix Policy Rule not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{matrixPolicyId}/matrix-policy-rule/{id}/clone": { "patch": { "tags": [ "Matrix Policy Rule" ], "summary": "An endpoint to clone selected Matrix Policy Rule", "operationId": "patch_app_accesspolicy_port_http_command_matrixpolicyrule_matrixpolicyrulecommand_clone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneMatrixPolicyRuleRequest" } } } }, "responses": { "204": { "description": "Rule has been cloned" }, "404": { "description": "Rule not found by given id" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{matrixPolicyId}/matrix-policy-rule/{id}/undelete": { "patch": { "tags": [ "Matrix Policy Rule" ], "summary": "An endpoint to undelete matrix policy rule.", "operationId": "patch_app_accesspolicy_port_http_command_matrixpolicyrule_matrixpolicyrulecommand_undelete", "parameters": [ { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix policy Rule has been assign as undeleted" }, "404": { "description": "Matrix Policy Rule not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-time": { "post": { "tags": [ "Matrix Policy Time" ], "summary": "An endpoint to create a new Matrix Policy Time.", "operationId": "post_app_accesspolicy_port_http_command_matrixpolicytime_matrixpolicytimecommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyTimeRequest" } } } }, "responses": { "201": { "description": "Matrix Policy Time has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-time/{id}": { "get": { "tags": [ "Matrix Policy Time" ], "summary": "An endpoint to retrieve Matrix Policy Time details.", "operationId": "get_app_accesspolicy_port_http_query_matrixpolicytime_matrixpolicytimequery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "return single Matrix Policy Time object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMatrixPolicyTimeResponse" } } } }, "404": { "description": "Not found Matrix Policy" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Matrix Policy Time" ], "summary": "An endpoint to update an existing Matrix Policy Time.", "operationId": "put_app_accesspolicy_port_http_command_matrixpolicytime_matrixpolicytimecommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatrixPolicyTimeRequest" } } } }, "responses": { "204": { "description": "Matrix Policy Time has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Matrix Policy Time not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Matrix Policy Time" ], "summary": "An endpoint to delete an existing Matrix Policy Time.", "operationId": "delete_app_accesspolicy_port_http_command_matrixpolicytime_matrixpolicytimecommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Matrix Policy Time has been deleted" }, "404": { "description": "Not found Matrix Policy Time" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/list": { "post": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to build and search Matrix Policies table.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicy_matrixpolicyquery_list", "requestBody": { "description": "JSON object containing data to search for Matrix Policies.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policies search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMatrixPolicyResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/mini-list": { "post": { "tags": [ "Matrix Policy" ], "summary": "Endpoint for searching the mini Matrix Policies list.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicy_matrixpolicyquery_minilist", "requestBody": { "description": "JSON object containing data to search for Matrix Policies.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policies search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{id}/testing": { "patch": { "tags": [ "Matrix Policy" ], "summary": "An endpoint to test the selected Matrix Policy.", "operationId": "patch_app_accesspolicy_port_http_query_matrixpolicy_matrixpolicyquery_test", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestMatrixPolicyRequest" } } } }, "responses": { "200": { "description": "Returns the test result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestingMatrixPolicyResponse" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Matrix Policy not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option/{matrixPolicyOptionId}/matrix-policy-option-item/list": { "post": { "tags": [ "Matrix Policy Option Item" ], "summary": "An endpoint to build and search Matrix Policy Option Item table.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyoption_matrixpolicyoptionitemquery_list", "parameters": [ { "name": "matrixPolicyOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Matrix Policy Option Item.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Option Item search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMatrixPolicyOptionItemResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option/{matrixPolicyOptionId}/matrix-policy-option-item/mini-list": { "post": { "tags": [ "Matrix Policy Option Item" ], "summary": "Endpoint for searching the mini Matrix Policy Option Item mini-list.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyoption_matrixpolicyoptionitemquery_minilist", "parameters": [ { "name": "matrixPolicyOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Matrix Policy Option Item.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Option Item search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionItemResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option/list": { "post": { "tags": [ "Matrix Policy Option" ], "summary": "An endpoint to build and search Matrix Policy Option table.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyoption_matrixpolicyoptionquery_list", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Options.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Option search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMatrixPolicyOptionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-option/mini-list": { "post": { "tags": [ "Matrix Policy Option" ], "summary": "Endpoint for searching the mini Matrix Policy Option list.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyoption_matrixpolicyoptionquery_minilist", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Option.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Option search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-profile-action/list": { "post": { "tags": [ "Matrix Policy Profile Action" ], "summary": "An endpoint to build and search Matrix Policy Profile Action table.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyprofileaction_matrixpolicyprofileactionquery_list", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Profile Action.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Profile Action search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMatrixPolicyProfileActionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-profile-action/mini-list": { "post": { "tags": [ "Matrix Policy Profile Action" ], "summary": "Endpoint for searching the mini Matrix Policy Profile Action list.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyprofileaction_matrixpolicyprofileactionquery_minilist", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Profile Action.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Profile Action search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyProfileActionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-category/list": { "post": { "tags": [ "Matrix Policy Category" ], "summary": "An endpoint to build and search Matrix Policy Category table.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyquery_matrixpolicycategoryquery_list", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Category.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Categories search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMatrixPolicyCategoryResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-category/mini-list": { "post": { "tags": [ "Matrix Policy Category" ], "summary": "Endpoint for searching the mini Matrix Policy Category list.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyquery_matrixpolicycategoryquery_minilist", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Category.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Categories search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{matrixPolicyId}/matrix-policy-rule/list": { "post": { "tags": [ "Matrix Policy Rule" ], "summary": "An endpoint to build and search Matrix Policy Rules table.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyrule_matrixpolicyrulequery_list", "parameters": [ { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Matrix Policy Rules.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Rules search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMatrixPolicyRuleResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy/{matrixPolicyId}/matrix-policy-rule/mini-list": { "post": { "tags": [ "Matrix Policy Rule" ], "summary": "Endpoint for searching the mini Matrix Policy Rules list.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicyrule_matrixpolicyrulequery_minilist", "parameters": [ { "name": "matrixPolicyId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Matrix Policy Rules.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Rules search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-time/list": { "post": { "tags": [ "Matrix Policy Time" ], "summary": "An endpoint to build and search Matrix Policy Times table.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicytime_matrixpolicytimequery_list", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Times.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Time search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMatrixPolicyTimeResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/matrix-policy-time/mini-list": { "post": { "tags": [ "Matrix Policy Time" ], "summary": "Endpoint for searching the mini Matrix Policy Times list.", "operationId": "post_app_accesspolicy_port_http_query_matrixpolicytime_matrixpolicytimequery_minilist", "requestBody": { "description": "JSON object containing data to search for Matrix Policy Times.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Matrix Policy Times search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyTimeResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{authorizationServerId}/access-group-external-identifier": { "post": { "tags": [ "Access Group External Identifier" ], "summary": "An endpoint to create a new Access Group External Identifier", "operationId": "post_app_authorizationserver_port_http_command_accessgroupidentifier_accessgroupexternalidentifiercommand_create", "parameters": [ { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to create a new Access Group External Identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessGroupExternalIdentifierRequest" } } } }, "responses": { "201": { "description": "Access Group External Identifier created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{authorizationServerId}/access-group-external-identifier/{id}": { "get": { "tags": [ "Access Group External Identifier" ], "summary": "An endpoint to retrieve Access Group External Identifier details.", "operationId": "get_app_authorizationserver_port_http_query_accessgroupexternalidentifier_accessgroupexternalidentifierquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Single Access Group External Identifier object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAccessGroupExternalIdentifierResponse" } } } }, "404": { "description": "Access Group External Identifier not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Access Group External Identifier" ], "summary": "An endpoint to update existing Access Group External Identifier", "operationId": "put_app_authorizationserver_port_http_command_accessgroupidentifier_accessgroupexternalidentifiercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to update an Access Group External Identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessGroupExternalIdentifierRequest" } } } }, "responses": { "201": { "description": "Access Group External Identifier updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Access Group External Identifier" ], "summary": "An endpoint to delete an existing Access Group External Identifier.", "operationId": "delete_app_authorizationserver_port_http_command_accessgroupidentifier_accessgroupexternalidentifiercommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Access Group External Identifier has been deleted" }, "404": { "description": "Access Group External Identifier not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to create new Authorization Server", "operationId": "post_app_authorizationserver_port_http_command_authorizationserver_authorizationservercommand_create", "requestBody": { "description": "Request to create a new Authorization Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationServerRequest" } } } }, "responses": { "201": { "description": "Authorization Server created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{id}": { "get": { "tags": [ "Authorization Server" ], "summary": "An endpoint to retrieve Authorization Server details.", "operationId": "get_app_authorizationserver_port_http_query_authorizationserver_authorizationserverquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Authorization Server object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAuthorizationServerResponse" } } } }, "404": { "description": "Authorization Server not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Authorization Server" ], "summary": "An endpoint to update new Authorization Server", "operationId": "put_app_authorizationserver_port_http_command_authorizationserver_authorizationservercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an Authorization Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationServerRequest" } } } }, "responses": { "204": { "description": "Authorization Server updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Authorization Server" ], "summary": "An endpoint to delete an existing AuthorizationServer.", "operationId": "delete_app_authorizationserver_port_http_command_authorizationserver_authorizationservercommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Authorization Server has been deleted" }, "404": { "description": "Authorization Server not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{id}/sync": { "patch": { "tags": [ "Authorization Server" ], "summary": "Start a synchronization process for an existing Authorization Server.", "operationId": "patch_app_authorizationserver_port_http_command_authorizationserver_authorizationservercommand_synchronize", "parameters": [ { "name": "id", "in": "path", "description": "Authorization Server ID", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Set isFullSync to true for full sync, false for incremental.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationServerSyncRequest" } } } }, "responses": { "202": { "description": "Synchronization requested successfully", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "example": "ddeb27fb-d9a0-4624-be4d-4615062daed4" }, "message": { "type": "string", "example": "Synchronization requested for Authorization Server ID 123 (incremental sync)." } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-tacacs": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Creator Tacacs details.", "operationId": "get_app_authorizationserver_port_http_query_creatortacacs_creatortacacsquery_view", "responses": { "200": { "description": "View Creator Tacacs object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorTacacsResponse" } } } }, "404": { "description": "Creator Tacacs not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator Tacacs", "operationId": "put_app_authorizationserver_port_http_command_creatortacacs_creatortacacscommand_update", "requestBody": { "description": "Request to update an Creator Tacacs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorTacacsRequest" } } } }, "responses": { "204": { "description": "Creator Tacacs updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/integration-server/{id}": { "get": { "tags": [ "Integration Server" ], "summary": "An endpoint to retrieve Integration Server details.", "operationId": "get_app_authorizationserver_port_http_query_integrationserver_integrationserverquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Integration Server object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIntegrationServerResponse" } } } }, "404": { "description": "Integration Server not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Integration Server" ], "summary": "An endpoint to update an Integration Server", "operationId": "put_app_authorizationserver_port_http_command_integrationserver_integrationservercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an Integration Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationServerRequest" } } } }, "responses": { "204": { "description": "Integration Server updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ldap-service": { "post": { "tags": [ "LDAP Service" ], "summary": "An endpoint to create new LDAP Service", "operationId": "post_app_authorizationserver_port_http_command_ldapservice_ldapservicecommand_create", "requestBody": { "description": "Request to create a new LDAP Service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapServiceRequest" } } } }, "responses": { "201": { "description": "LDAP Service created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ldap-service/{id}": { "get": { "tags": [ "LDAP Service" ], "summary": "An endpoint to view one LDAP Service details.", "operationId": "get_app_authorizationserver_port_http_query_ldapservice_ldapservicequery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Ldap Service not found." }, "200": { "description": "Returns the result of the Entity LDAP Service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewLdapServiceResponse" } } } } } }, "put": { "tags": [ "LDAP Service" ], "summary": "An endpoint to update an existing LDAP Service.", "operationId": "put_app_authorizationserver_port_http_command_ldapservice_ldapservicecommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to create a new LDAP Service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapServiceRequest" } } } }, "responses": { "204": { "description": "LDAP Service has been updated" }, "404": { "description": "LDAP Service not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "LDAP Service" ], "summary": "An endpoint to delete an existing LDAP Service.", "operationId": "delete_app_authorizationserver_port_http_command_ldapservice_ldapservicecommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "LDAP Service has been deleted" }, "404": { "description": "LDAP Service not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ldap-service/{ldapServiceId}/ldap-service-referral": { "post": { "tags": [ "Ldap Service Referral" ], "summary": "An endpoint to create a new LDAP Service Referral", "operationId": "post_app_authorizationserver_port_http_command_ldapservicereferral_ldapservicereferralcommand_create", "parameters": [ { "name": "ldapServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to create a new LDAP Service Referral", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapServiceReferralRequest" } } } }, "responses": { "201": { "description": "Ldap Service Referral has been created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ldap-service/{ldapServiceId}/ldap-service-referral/{id}": { "get": { "tags": [ "Ldap Service Referral" ], "summary": "An endpoint to view LDAP Service Referral.", "operationId": "get_app_authorizationserver_port_http_query_ldapservicereferral_ldapservicereferralquery_view", "parameters": [ { "name": "ldapServiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Ldap Service Referral not found." }, "200": { "description": "Returns the result of the LDAP Service Referral.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewLdapServiceReferralResponse" } } } } } }, "put": { "tags": [ "Ldap Service Referral" ], "summary": "An endpoint to update existing LDAP Service Referral", "operationId": "put_app_authorizationserver_port_http_command_ldapservicereferral_ldapservicereferralcommand_update", "parameters": [ { "name": "ldapServiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an existing LDAP Service Referral", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapServiceReferralRequest" } } } }, "responses": { "204": { "description": "Ldap Service Referral has been updated successfully" }, "400": { "description": "Incorrect update payload" }, "404": { "description": "Ldap Service Referral not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Ldap Service Referral" ], "summary": "An endpoint to delete an existing LDAP Service Referral", "operationId": "delete_app_authorizationserver_port_http_command_ldapservicereferral_ldapservicereferralcommand_delete", "parameters": [ { "name": "ldapServiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Ldap Service Referral has been deleted successfully" }, "404": { "description": "Ldap Service Referral not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ldap-service-system-node-parameter": { "post": { "tags": [ "LDAP Service System Node Parameter" ], "summary": "An endpoint to create new LDAP Service System Node Parameters", "operationId": "post_app_authorizationserver_port_http_command_ldapservicesystemnodeparameter_ldapservicesystemnodeparametercommand_create", "requestBody": { "description": "Request to create a new LDAP Service System Node Parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLdapServiceSystemNodeParameterRequest" } } } }, "responses": { "201": { "description": "LDAP Service System Node Parameters created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ldap-service-system-node-parameter/{id}": { "get": { "tags": [ "LDAP Service System Node Parameter" ], "summary": "An endpoint to view one LDAP Service System Node Parameter details.", "operationId": "get_app_authorizationserver_port_http_query_ldapservicesystemnodeparameter_ldapservicesystemnodeparameterquery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Ldap Service not found." }, "200": { "description": "Returns the result of the Entity LDAP Service System Node Parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewLdapServiceSystemNodeParameterResponse" } } } } } }, "put": { "tags": [ "LDAP Service System Node Parameter" ], "summary": "An endpoint to update an existing LDAP Service System Node Parameters.", "operationId": "put_app_authorizationserver_port_http_command_ldapservicesystemnodeparameter_ldapservicesystemnodeparametercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an existing LDAP Service System Node Parameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditLdapServiceSystemNodeParameterRequest" } } } }, "responses": { "204": { "description": "LDAP Service System Node Parameters has been updated" }, "404": { "description": "LDAP Service System Node Parameters not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "LDAP Service System Node Parameter" ], "summary": "An endpoint to delete an existing LDAP Service System Node Parameters.", "operationId": "delete_app_authorizationserver_port_http_command_ldapservicesystemnodeparameter_ldapservicesystemnodeparametercommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "LDAP Service System Node Parameters has been deleted" }, "404": { "description": "LDAP Service System Node Parameters not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{authorizationServerId}/object-group-external-identifier": { "post": { "tags": [ "Object Group External Identifier" ], "summary": "An endpoint to create a new object group external identifier", "operationId": "post_app_authorizationserver_port_http_command_objectgroupidentifier_objectgroupexternalidentifiercommand_create", "parameters": [ { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to create a new Object Group External Identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectGroupExternalIdentifierRequest" } } } }, "responses": { "201": { "description": "Object group external identifier created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{authorizationServerId}/object-group-external-identifier/{id}": { "get": { "tags": [ "Object Group External Identifier" ], "summary": "An endpoint to retrieve Object Group External Identifier details.", "operationId": "get_app_authorizationserver_port_http_query_objectgroupexternalidentifier_objectgroupexternalidentifierquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Single Object Group Identifier object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewObjectGroupExternalIdentifierResponse" } } } }, "404": { "description": "Object Group External Identifier not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Object Group External Identifier" ], "summary": "An endpoint to update the existing Object group external identifier", "operationId": "put_app_authorizationserver_port_http_command_objectgroupidentifier_objectgroupexternalidentifiercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to update an Object group external identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectGroupExternalIdentifierRequest" } } } }, "responses": { "204": { "description": "Object group external identifier updated successfully" }, "400": { "description": "Incorrect update payload" }, "404": { "description": "Object group external identifier not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Object Group External Identifier" ], "summary": "An endpoint to delete an existing Object group external identifier.", "operationId": "delete_app_authorizationserver_port_http_command_objectgroupidentifier_objectgroupexternalidentifiercommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Object group external identifier has been deleted" }, "404": { "description": "Object group external identifier not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tacacs-server": { "post": { "tags": [ "TACACS Server" ], "summary": "An endpoint to create a new TACACS Server", "operationId": "post_app_authorizationserver_port_http_command_tacacsserver_tacacsservercommand_create", "requestBody": { "description": "Request to create a new TACACS Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerRequest" } } } }, "responses": { "201": { "description": "Tacacs Server has been created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tacacs-server/{id}": { "get": { "tags": [ "TACACS Server" ], "summary": "An endpoint to view Tacacs Server.", "operationId": "get_app_authorizationserver_port_http_query_tacacsserver_tacacsserverquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Tacacs Server not found." }, "200": { "description": "Returns the result of the Tacacs server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewTacacsServerResponse" } } } } } }, "put": { "tags": [ "TACACS Server" ], "summary": "An endpoint to update the existing TACACS Server", "operationId": "put_app_authorizationserver_port_http_command_tacacsserver_tacacsservercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a new TACACS Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerRequest" } } } }, "responses": { "201": { "description": "Tacacs Server has been created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "TACACS Server" ], "summary": "An endpoint to delete existing TACACS Server", "operationId": "delete_app_authorizationserver_port_http_command_tacacsserver_tacacsservercommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Tacacs Server has been deleted successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tacacs-server/{tacacsServerId}/custom-parameter": { "post": { "tags": [ "TACACS Server Custom Parameter" ], "summary": "An endpoint to create a new TACACS Server CustomParameter", "operationId": "post_app_authorizationserver_port_http_command_tacacsservercustomparameter_tacacsservercustomparameter_create", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to create a new TACACS Server CustomParameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerCustomParameterRequest" } } } }, "responses": { "201": { "description": "Tacacs Server Custom Parameter has been created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tacacs-server/{tacacsServerId}/custom-parameter/{id}": { "get": { "tags": [ "TACACS Server Custom Parameter" ], "summary": "An endpoint to view Tacacs Server CustomParameter.", "operationId": "get_app_authorizationserver_port_http_query_tacacsservercustomparameter_tacacsservercustomparameterquery_view", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Tacacs Server not found." }, "200": { "description": "Returns the result of the Tacacs server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewTacacsServerCustomParameterResponse" } } } } } }, "put": { "tags": [ "TACACS Server Custom Parameter" ], "summary": "An endpoint to update the existing TACACS Server Custom Parameter", "operationId": "put_app_authorizationserver_port_http_command_tacacsservercustomparameter_tacacsservercustomparameter_update", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a new TACACS Server Custom Parameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerCustomParameterRequest" } } } }, "responses": { "204": { "description": "Tacacs Server Custom Parameter has been updated successfully" }, "400": { "description": "Incorrect create payload" }, "404": { "description": "Tacacs Server Custom Parameter not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "TACACS Server Custom Parameter" ], "summary": "An endpoint to delete existing TACACS Server Custom Parameter", "operationId": "delete_app_authorizationserver_port_http_command_tacacsservercustomparameter_tacacsservercustomparameter_delete", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to delete a new TACACS Server Custom Parameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerCustomParameterRequest" } } } }, "responses": { "201": { "description": "Tacacs Server Custom Parameter has been deleted successfully" }, "404": { "description": "Tacacs Server Custom Parameter not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tacacs-server/{tacacsServerId}/tacacs-server-settings": { "post": { "tags": [ "TACACS Server Settings" ], "summary": "An endpoint to create new TACACS Server Settings", "operationId": "post_app_authorizationserver_port_http_command_tacacsserversettings_tacacsserversettings_create", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to create a new TACACS Server Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerSettingsRequest" } } } }, "responses": { "201": { "description": "Tacacs Server has been created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tacacs-server/{tacacsServerId}/tacacs-server-settings/{id}": { "get": { "tags": [ "TACACS Server Settings" ], "summary": "An endpoint to view Tacacs Server Settings.", "operationId": "get_app_authorizationserver_port_http_query_tacacsserversettings_tacacsserversettingsquery_view", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Tacacs Server Settings not found." }, "200": { "description": "Returns the result of the Tacacs server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewTacacsServerSettingsResponse" } } } } } }, "put": { "tags": [ "TACACS Server Settings" ], "summary": "An endpoint to update existing TACACS Server Settings", "operationId": "put_app_authorizationserver_port_http_command_tacacsserversettings_tacacsserversettings_update", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a new TACACS Server Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerSettingsRequest" } } } }, "responses": { "201": { "description": "Tacacs Server has been created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "TACACS Server Settings" ], "summary": "An endpoint to delete existing TACACS Server Settings", "operationId": "delete_app_authorizationserver_port_http_command_tacacsserversettings_tacacsserversettings_delete", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to delete a new TACACS Server Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TacacsServerSettingsRequest" } } } }, "responses": { "201": { "description": "Tacacs Server has been deleted successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{authorizationServerId}/access-group-external-identifier/list": { "post": { "tags": [ "Access Group External Identifier" ], "summary": "An endpoint to build and search Access Group External Identifier table.", "operationId": "post_app_authorizationserver_port_http_query_accessgroupexternalidentifier_accessgroupexternalidentifierquery_list", "parameters": [ { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Access Group External Identifiers.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Access Group External Identifier search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListAccessGroupExternalIdentifierResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{authorizationServerId}/access-group-external-identifier/mini-list": { "post": { "tags": [ "Access Group External Identifier" ], "summary": "Endpoint for searching the mini Access Group External Identifiers list.", "operationId": "post_app_authorizationserver_port_http_query_accessgroupexternalidentifier_accessgroupexternalidentifierquery_minilist", "parameters": [ { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Access Group External Identifiers.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Access Group External Identifier search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupExternalIdentifierResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/list": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to build and search Authorization Server table.", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_authorizationserverquery_list", "requestBody": { "description": "JSON object containing data to search for Authorization Servers.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListAuthorizationServerResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/mini-list": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to build and search Authorization Server mini list.", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_authorizationserverquery_minilist", "requestBody": { "description": "JSON object containing data to search for Authorization Servers.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{id}/fetch-groups/ldap": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to find groups in LDAP", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_findgroupsinexternalservice_fetchldapgroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to find organization units with connection credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchLdapGroupsRequest" } } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FetchLdapGroupsResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect payload." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{id}/fetch-groups/sql": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to find groups in SQL", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_findgroupsinexternalservice_fetchsqlgroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to find organization units with connection credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchSqlGroupsRequest" } } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FetchSqlGroupsResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect payload." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/ldap/find-root-dse": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to find root dse in given by url LDAP", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_ldapauthorizationserver_findrootdse", "requestBody": { "description": "Request to find root dse.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRootDseRequest" } } } }, "responses": { "200": { "description": "Ldap root dse found correctly..", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapRootDseResponse" } } } }, "400": { "description": "Incorrect payload." }, "404": { "description": "Root dse not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/ldap/find-organization-units": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to find organization units in LDAP", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_ldapauthorizationserver_findorganizationunits", "requestBody": { "description": "Request to find organization units.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindOrganizationUnitsStructureRequest" } } } }, "responses": { "200": { "description": "Ldap organization units found correctly.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUnitsResponse" } } } }, "400": { "description": "Incorrect payload." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/ldap/find-organization-units-by-credentials": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to find organization units by credentials in LDAP", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_ldapauthorizationserver_findorganizationunitsbycredentials", "requestBody": { "description": "Request to find organization units with connection credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindOrganizationUnitsStructureByCredentialsRequest" } } } }, "responses": { "200": { "description": "Ldap organization units found correctly.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUnitsResponse" } } } }, "400": { "description": "Incorrect payload." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/ldap/fetch-record": { "post": { "tags": [ "Authorization Server" ], "summary": "An endpoint to get single record by DN", "operationId": "post_app_authorizationserver_port_http_query_authorizationserver_ldapauthorizationserver_fetchrecord", "requestBody": { "description": "Request to find record by DN.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchRecordByDnRequest" } } } }, "responses": { "200": { "description": "Record found correctly.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordByDnResponse" } } } }, "400": { "description": "Incorrect payload." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/integration-server/list": { "post": { "tags": [ "Integration Server" ], "summary": "An endpoint to build and search Integration Server table.", "operationId": "post_app_authorizationserver_port_http_query_integrationserver_integrationserverquery_list", "requestBody": { "description": "JSON object containing data to search for Integration Server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListIntegrationServerResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/integration-server/mini-list": { "post": { "tags": [ "Integration Server" ], "summary": "An endpoint to build and search Integration Server mini list.", "operationId": "post_app_authorizationserver_port_http_query_integrationserver_integrationserverquery_minilist", "requestBody": { "description": "JSON object containing data to search for Integration Server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIntegrationServerResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/integration-server/{id}/test-connection": { "get": { "tags": [ "Integration Server" ], "summary": "An endpoint to test Integration Server connection.", "operationId": "get_app_authorizationserver_port_http_query_integrationserver_integrationserverquery_testconnection", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Connection test. Check response to see status or error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationServerTestConnectionStatus" } } } }, "404": { "description": "Integration Server not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ldap-service/list": { "post": { "tags": [ "LDAP Service" ], "summary": "An endpoint to build and search LDAP Service table.", "operationId": "post_app_authorizationserver_port_http_query_ldapservice_ldapservicequery_list", "requestBody": { "description": "JSON object containing data to search for LDAP Services.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListLdapServiceResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/ldap-service/mini-list": { "post": { "tags": [ "LDAP Service" ], "summary": "An endpoint to build and search LDAP service mini list.", "operationId": "post_app_authorizationserver_port_http_query_ldapservice_ldapservicequery_minilist", "requestBody": { "description": "JSON object containing data to search for LDAP Services.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListLdapServiceResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/ldap-service/{ldapServiceId}/ldap-service-referral/list": { "post": { "tags": [ "Ldap Service Referral" ], "summary": "An endpoint to list LDAP Service Referral.", "operationId": "post_app_authorizationserver_port_http_query_ldapservicereferral_ldapservicereferralquery_list", "parameters": [ { "name": "ldapServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for LDAP Service Referral.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListLdapServiceReferralResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/ldap-service/{ldapServiceId}/ldap-service-referral/mini-list": { "post": { "tags": [ "Ldap Service Referral" ], "summary": "An endpoint to mini-list LDAP Service Referral.", "operationId": "post_app_authorizationserver_port_http_query_ldapservicereferral_ldapservicereferralquery_minilist", "parameters": [ { "name": "ldapServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for LDAP Service Referral.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListLdapServiceReferralResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/ldap-service-system-node-parameter/list": { "post": { "tags": [ "LDAP Service System Node Parameter" ], "summary": "An endpoint to build and search LDAP Service System Node Parameter table.", "operationId": "post_app_authorizationserver_port_http_query_ldapservicesystemnodeparameter_ldapservicesystemnodeparameterquery_list", "requestBody": { "description": "JSON object containing data to search for LDAP Services.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListLdapServiceSystemNodeParameterResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/ldap-service-system-node-parameter/mini-list": { "post": { "tags": [ "LDAP Service System Node Parameter" ], "summary": "An endpoint to build and search LDAP service mini list.", "operationId": "post_app_authorizationserver_port_http_query_ldapservicesystemnodeparameter_ldapservicesystemnodeparameterquery_minilist", "requestBody": { "description": "JSON object containing data to search for LDAP Services.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListLdapServiceSystemNodeParameterResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/authorization-server/{authorizationServerId}/object-group-external-identifier/list": { "post": { "tags": [ "Object Group External Identifier" ], "summary": "An endpoint to build and search Object Group External Identifier table.", "operationId": "post_app_authorizationserver_port_http_query_objectgroupexternalidentifier_objectgroupexternalidentifierquery_list", "parameters": [ { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Object Group External Identifier.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Object Group External Identifier search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListObjectGroupExternalIdentifierResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/authorization-server/{authorizationServerId}/object-group-external-identifier/mini-list": { "post": { "tags": [ "Object Group External Identifier" ], "summary": "Endpoint for searching the mini Object Group External Identifier list.", "operationId": "post_app_authorizationserver_port_http_query_objectgroupexternalidentifier_objectgroupexternalidentifierquery_minilist", "parameters": [ { "name": "authorizationServerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for Object Group External Identifier.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Object Group External Identifier search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupExternalIdentifierResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tacacs-server/list": { "post": { "tags": [ "TACACS Server" ], "summary": "An endpoint to list Tacacs Server.", "operationId": "post_app_authorizationserver_port_http_query_tacacsserver_tacacsserverquery_list", "requestBody": { "description": "JSON object containing data to search for Tacacs server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListTacacsServerResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/tacacs-server/mini-list": { "post": { "tags": [ "TACACS Server" ], "summary": "An endpoint to mini-list Tacacs Server.", "operationId": "post_app_authorizationserver_port_http_query_tacacsserver_tacacsserverquery_minilist", "requestBody": { "description": "JSON object containing data to search for Tacacs server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListTacacsServerResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/tacacs-server/{tacacsServerId}/custom-parameter/list": { "post": { "tags": [ "TACACS Server Custom Parameter" ], "summary": "An endpoint to list Tacacs Server CustomParameter.", "operationId": "post_app_authorizationserver_port_http_query_tacacsservercustomparameter_tacacsservercustomparameterquery_list", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for Tacacs server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListTacacsServerCustomParameterResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/tacacs-server/{tacacsServerId}/custom-parameter/mini-list": { "post": { "tags": [ "TACACS Server Custom Parameter" ], "summary": "An endpoint to mini-list Tacacs Server CustomParameter.", "operationId": "post_app_authorizationserver_port_http_query_tacacsservercustomparameter_tacacsservercustomparameterquery_minilist", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for Tacacs server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListTacacsServerCustomParameterResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/tacacs-server/{tacacsServerId}/tacacs-server-settings/list": { "post": { "tags": [ "TACACS Server Settings" ], "summary": "An endpoint to list Tacacs Server Settings.", "operationId": "post_app_authorizationserver_port_http_query_tacacsserversettings_tacacsserversettingsquery_list", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for Tacacs server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListTacacsServerSettingsResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/tacacs-server/{tacacsServerId}/tacacs-server-settings/mini-list": { "post": { "tags": [ "TACACS Server Settings" ], "summary": "An endpoint to mini-list Tacacs Server Settings.", "operationId": "post_app_authorizationserver_port_http_query_tacacsserversettings_tacacsserversettingsquery_minilist", "parameters": [ { "name": "tacacsServerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for Tacacs server.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListTacacsServerSettingsResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/object-certificate": { "post": { "tags": [ "Object Certificate" ], "summary": "An endpoint to create a new Object Certificate.", "operationId": "post_app_certificate_port_http_command_objectcertificate_objectcertificate_create", "requestBody": { "description": "Request to create a new Object certificate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectCertificateRequest" } } } }, "responses": { "201": { "description": "Object certificate has been created." }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-certificate/{id}": { "get": { "tags": [ "Object Certificate" ], "summary": "An endpoint to retrieve Object Certificate details.", "operationId": "get_app_certificate_port_http_query_objectcertificate_objectcertificatequery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Object Certificate object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewObjectCertificateResponse" } } } }, "404": { "description": "Object Certificate not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Object Certificate" ], "summary": "An endpoint to update existing Object Certificate.", "operationId": "put_app_certificate_port_http_command_objectcertificate_objectcertificate_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to create a new Object certificate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectCertificateRequest" } } } }, "responses": { "204": { "description": "Object certificate has been updated." }, "400": { "description": "Incorrect update payload" }, "404": { "description": "Could not found Object Certificate." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Object Certificate" ], "summary": "An endpoint to delete existing Object Certificate.", "operationId": "delete_app_certificate_port_http_command_objectcertificate_objectcertificate_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Object certificate has been deleted." }, "404": { "description": "Object certificate not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/chain": { "post": { "tags": [ "PKI" ], "summary": "Endpoint adds a new certificate to the hierarchy tree for external and external-csr.", "operationId": "post_app_certificate_port_http_command_pki_external_chainexternalpki_createchain", "parameters": [ { "parameter": "caCertificate", "name": "caCertificate", "in": "header", "schema": { "description": "CA Certificate file", "type": "file" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "multipart/form-data": {} } }, "responses": { "201": { "description": "Chain created successfully" }, "404": { "description": "Chain not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/chain/{serialNumber}": { "put": { "tags": [ "PKI" ], "summary": "An endpoint that edits an existing certificate in the tree hierarchy for external and external-csr.", "operationId": "put_app_certificate_port_http_command_pki_external_chainexternalpki_updatechain", "parameters": [ { "parameter": "caCertificate", "name": "caCertificate", "in": "header", "schema": { "description": "CA Certificate file", "type": "file" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "serialNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": {} } }, "responses": { "204": { "description": "Chain created successfully" }, "404": { "description": "Chain not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "PKI" ], "summary": "An endpoint for deleting an existing chain certificate in the tree hierarchy for external and external-csr.", "operationId": "delete_app_certificate_port_http_command_pki_external_chainexternalpki_deletechain", "parameters": [ { "name": "serialNumber", "in": null, "description": "The certification chain identifier", "required": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "serialNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Chain has been deleted" }, "409": { "description": "The certificate chain cannot be deleted because it has child certificates" }, "404": { "description": "Chain not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/external-csr": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to view request for External CSR PKI.", "operationId": "get_app_certificate_port_http_query_pki_externalcsrpki_viewrequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Not found " }, "200": { "description": "Returns the result of request for CSR.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewExternalPkiResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "PKI" ], "summary": "An endpoint to update a request for External PKI CSR.", "operationId": "put_app_certificate_port_http_command_pki_external_externalcsrpki_updatecsrprimarydata", "parameters": [ { "name": "id", "in": "path", "description": "PKI id", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to generate a request for CSR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCsrPkiRequest" } } } }, "responses": { "201": { "description": "Successfully generated a request" }, "404": { "description": "PKI not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/external-csr/request": { "put": { "tags": [ "PKI" ], "summary": "An endpoint to update a request for External PKI CSR.", "operationId": "put_app_certificate_port_http_command_pki_external_externalcsrpki_updatecsrcadata", "parameters": [ { "name": "id", "in": "path", "description": "PKI id", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to create a request for CSR generation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerCaRequest" } } } }, "responses": { "204": { "description": "Successfully updated request to generate CSR" }, "404": { "description": "PKI not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/external": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to view External PKI.", "operationId": "get_app_certificate_port_http_query_pki_externalpki_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "External PKI not found." }, "200": { "description": "Returns the result of the PKI.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewExternalPkiResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "PKI" ], "summary": "An endpoint to update an existing PKI.", "operationId": "put_app_certificate_port_http_command_pki_external_externalpki_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an existing PKI", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPkiRequest" } } } }, "responses": { "204": { "description": "Pki has been updated" }, "404": { "description": "Pki not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/file/ca-certificate": { "post": { "tags": [ "PKI" ], "summary": "An endpoint to add a PKI CA certificate file for external and external-csr certificate.", "operationId": "post_app_certificate_port_http_command_pki_external_pkifileupload_uploadexternalcacertfile", "parameters": [ { "parameter": "caCertificate", "name": "caCertificate", "in": "header", "schema": { "description": "CA Certificate file", "type": "file" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "multipart/form-data": {} } }, "responses": { "204": { "description": "Files has been added to PKI" }, "404": { "description": "PKI not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/file/server-certificate": { "post": { "tags": [ "PKI" ], "summary": "An endpoint to add a PKI Server Certificate file for external and external-csr certificate.", "operationId": "post_app_certificate_port_http_command_pki_external_pkifileupload_uploadexternalservercertificatefile", "parameters": [ { "parameter": "serverCertificate", "name": "serverCertificate", "in": "header", "schema": { "description": "Server Certificate file", "type": "file" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "multipart/form-data": {} } }, "responses": { "204": { "description": "Files has been added to PKI" }, "404": { "description": "PKI not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/file/private-server-key": { "post": { "tags": [ "PKI" ], "summary": "An endpoint to add a PKI Private Server Key file for external certificate.", "operationId": "post_app_certificate_port_http_command_pki_external_pkifileupload_uploadexternalprivateserverkeyfile", "parameters": [ { "parameter": "privateServerKey", "name": "privateServerKey", "in": "header", "schema": { "description": "CA Certificate file", "type": "file" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "multipart/form-data": {} } }, "responses": { "204": { "description": "Files has been added to PKI" }, "404": { "description": "PKI not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/internal/ca": { "put": { "tags": [ "PKI" ], "summary": "An endpoint to update an existing Internal Pki CA.", "operationId": "put_app_certificate_port_http_command_pki_internal_internalpki_updateca", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an existing PKI CA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalCaRequest" } } } }, "responses": { "204": { "description": "Pki has been updated" }, "404": { "description": "Pki not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/internal/server": { "put": { "tags": [ "PKI" ], "summary": "An endpoint to update an existing Internal Pki Server.", "operationId": "put_app_certificate_port_http_command_pki_internal_internalpki_updateserverca", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an existing PKI Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerRequest" } } } }, "responses": { "204": { "description": "Server CA has been updated" }, "404": { "description": "Pki not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/internal": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to view Internal PKI.", "operationId": "get_app_certificate_port_http_query_pki_internalpki_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Internal PKI not found." }, "200": { "description": "Returns the result of the PKI.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewInternalPkiResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "PKI" ], "summary": "An endpoint to modify PKI primary data.", "operationId": "put_app_certificate_port_http_command_pki_internal_internalpki_updateprimarydata", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update basic PKI data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditPkiRequest" } } } }, "responses": { "204": { "description": "PKI has been updated" }, "404": { "description": "PKI not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "patch": { "tags": [ "PKI" ], "summary": "An endpoint to generate all internal PKI certificate.", "operationId": "patch_app_certificate_port_http_command_pki_internal_internalpki_generate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to generate all or only server certificate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalGenerateCertificateRequest" } } } }, "responses": { "404": { "description": "PKI not found by given id" }, "204": { "description": "Generated successfully " }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}": { "delete": { "tags": [ "PKI" ], "summary": "An endpoint to remove pki.", "operationId": "delete_app_certificate_port_http_command_pki_pki_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Pki has been deleted." }, "400": { "description": "Invalid search payload" }, "409": { "description": "Cannot delete object because it is used in other objects" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki": { "post": { "tags": [ "PKI" ], "summary": "An endpoint to create basic empty pki.", "operationId": "post_app_certificate_port_http_command_pki_pki_createpki", "requestBody": { "description": "Request to generate a request for CSR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractBasicPkiRequest" } } } }, "responses": { "201": { "description": "successfully generated a request", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "404": { "description": "PKI not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-certificate/{id}/generate/pkcs12": { "patch": { "tags": [ "Object Certificate" ], "summary": "An endpoint to download pkcs12 certificate.", "operationId": "patch_app_certificate_port_http_query_objectcertificate_objectcertificatefile_downloadp12", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single p12 certificate", "content": { "application/x-pkcs12": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Object Certificate not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-certificate/list": { "post": { "tags": [ "Object Certificate" ], "summary": "An endpoint to search Object Certificate table.", "operationId": "post_app_certificate_port_http_query_objectcertificate_objectcertificatequery_list", "requestBody": { "description": "JSON object containing data to search for Object Certificate.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Object Certificates search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListObjectCertificateResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-certificate/mini-list": { "post": { "tags": [ "Object Certificate" ], "summary": "Endpoint for searching the mini Object Certificate list.", "operationId": "post_app_certificate_port_http_query_objectcertificate_objectcertificatequery_minilist", "requestBody": { "description": "JSON object containing data to search for Object Certificates.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Object Certificate search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectCertificateResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/external-csr/csr": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to fetch generated certificate for External CSR PKI.", "operationId": "get_app_certificate_port_http_query_pki_externalcsrpki_viewcertificate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Not found " }, "200": { "description": "Returns the result of request for CSR.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedCertificateResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/internal/crl": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to view CRL data.", "operationId": "get_app_certificate_port_http_query_pki_internalpki_getcrl", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Internal CRL not found." }, "200": { "description": "Returns the result of the CRL data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewInternalCrlResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/list": { "post": { "tags": [ "PKI" ], "summary": "An endpoint to build and search PKI table.", "operationId": "post_app_certificate_port_http_query_pki_pkiquery_list", "requestBody": { "description": "JSON object containing data to search for PKI.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListPkiResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/mini-list": { "post": { "tags": [ "PKI" ], "summary": "Endpoint for mini list.", "operationId": "post_app_certificate_port_http_query_pki_pkiquery_minilist", "requestBody": { "description": "JSON object containing data to search for PKI.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListPkiResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/ca": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to view PKI CA.", "operationId": "get_app_certificate_port_http_query_pki_pkiquery_getcacertificate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "CA PKI not found." }, "200": { "description": "Returns the result of the PKI.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCaPkiResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/public-server": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to view PKI Public Server Certificate.", "operationId": "get_app_certificate_port_http_query_pki_pkiquery_getpublicservercertificate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Public Server Certificate not found." }, "200": { "description": "Returns the result of the PKI.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewPublicServerCertificatePkiResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/pki/{id}/chain/{chainId}": { "get": { "tags": [ "PKI" ], "summary": "An endpoint to view PKI Chain Certificate.", "operationId": "get_app_certificate_port_http_query_pki_pkiquery_getchaincertificate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "chainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Chain Certificate PKI not found." }, "200": { "description": "Returns the result of the PKI.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewChainCertificatePkiResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/import": { "post": { "tags": [ "Import/Export" ], "summary": "Upload CSV. Validates headers and rows, returns uuid.", "operationId": "post_app_dataexchange_port_http_command_importdata_import", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file", "importType" ], "properties": { "importType": { "type": "enum", "enum": [ "vlan", "identity", "endpoint-device", "subnetwork", "mac-address", "network-device" ] }, "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "400": { "description": "Invalid request" }, "201": { "description": "created import context queue", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "example": "a981a6d0-da0f-4d27-ba3c-50740d03308b" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/import/{id}/apply": { "patch": { "tags": [ "Import/Export" ], "operationId": "patch_app_dataexchange_port_http_command_importdata_apply", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "apply import context queue", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "example": "a981a6d0-da0f-4d27-ba3c-50740d03308b" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/import/example/{type}": { "patch": { "tags": [ "Import/Export" ], "summary": "An endpoint to generate example of import", "operationId": "patch_app_dataexchange_port_http_query_importdatafilequery_generatefile", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "vlan", "identity", "endpoint-device", "subnetwork", "mac-address", "network-device" ] } } ], "responses": { "200": { "description": "Single example CSV file", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/import/list": { "post": { "tags": [ "Import/Export" ], "summary": "An endpoint to build and search import context table.", "operationId": "post_app_dataexchange_port_http_query_importdataquery_list", "requestBody": { "description": "JSON object containing data to search for import context.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"uuid\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"createdAt\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of import context search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListImportContextResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/import/{id}": { "get": { "tags": [ "Import/Export" ], "summary": "An endpoint to retrieve import context details.", "operationId": "get_app_dataexchange_port_http_query_importdataquery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Single import context object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewImportContextResponse" } } } }, "404": { "description": "Import context not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/monitoring/endpoint-device/{uuid}/sync/node": { "patch": { "tags": [ "Monitoring" ], "summary": "An endpoint to sync endpoint device node", "operationId": "patch_app_monitoring_port_http_command_syncnodedata_endpointdevicesync", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Node has been synced" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/monitoring/network-device/{uuid}/sync/node": { "patch": { "tags": [ "Monitoring" ], "summary": "An endpoint to sync master monitoring node", "operationId": "patch_app_monitoring_port_http_command_syncnodedata_networkdevicesync", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Master has been synced" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/color-identifier": { "post": { "tags": [ "Color Identifier" ], "summary": "An endpoint to create a new Color Identifier.", "operationId": "post_app_networkarchitecture_port_http_command_coloridentifier_coloridentifiercommand_create", "requestBody": { "description": "Request to create a new Color Identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorIdentifierRequest" } } } }, "responses": { "201": { "description": "Color Identifier has been created" }, "400": { "description": "Incorrect create payload" } } } }, "/api/v3/color-identifier/{id}": { "get": { "tags": [ "Color Identifier" ], "summary": "An endpoint to get Color Identifier details.", "operationId": "get_app_networkarchitecture_port_http_query_coloridentifier_coloridentifierquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Color Identifier not found." }, "200": { "description": "Returns the Color Identifier object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewColorIdentifierResponse" } } } } } }, "put": { "tags": [ "Color Identifier" ], "summary": "An endpoint to update a Color Identifier.", "operationId": "put_app_networkarchitecture_port_http_command_coloridentifier_coloridentifiercommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update Color Identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorIdentifierRequest" } } } }, "responses": { "204": { "description": "Color identifier has been updated" }, "404": { "description": "Color identifier not found by given id" } } }, "delete": { "tags": [ "Color Identifier" ], "summary": "An endpoint to delete an existing Color Identifier.", "operationId": "delete_app_networkarchitecture_port_http_command_coloridentifier_coloridentifiercommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Color Identifier has been deleted" }, "404": { "description": "Color Identifier not found by given id" } } } }, "/api/v3/config/creator-eduroam": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to view Creator Eduroam configuration", "operationId": "get_app_networkarchitecture_port_http_query_creatoreduroam_viewcreatoreduroam_index", "responses": { "200": { "description": "Creator Eduroam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorEduroamResponse" } } } }, "500": { "description": "The running Creator Eduroam not found.", "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "Internal error" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator Eduroam configuration", "operationId": "put_app_networkarchitecture_port_http_command_creatoreduroam_creatoreduroamcommand_update", "requestBody": { "description": "Request to update Creator Eduroam configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorEduroamRequest" } } } }, "responses": { "204": { "description": "Configuration updated correctly" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-monitoring": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Creator Monitoring details.", "operationId": "get_app_networkarchitecture_port_http_query_creatormonitoring_creatormonitoringquery_view", "responses": { "200": { "description": "View Creator Monitoring object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorMonitoringResponse" } } } }, "404": { "description": "Creator Monitoring not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator Monitoring", "operationId": "put_app_networkarchitecture_port_http_command_creatormonitoring_creatormonitoringcommand_update", "requestBody": { "description": "Request to update an Creator Monitoring", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorMonitoringRequest" } } } }, "responses": { "204": { "description": "Creator Monitoring updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-option": { "post": { "tags": [ "Dhcp Option" ], "summary": "An endpoint to create a new DhcpOption.", "operationId": "post_app_networkarchitecture_port_http_command_dhcpoption_dhcpoptioncommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DhcpOptionRequest" } } } }, "responses": { "201": { "description": "DhcpOption has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-option/{id}": { "get": { "tags": [ "Dhcp Option" ], "summary": "An endpoint to retrieve DhcpOption details.", "operationId": "get_app_networkarchitecture_port_http_query_dhcpoption_dhcpoptionquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single DhcpOption object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewDhcpOptionResponse" } } } }, "404": { "description": "DhcpOption not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Dhcp Option" ], "summary": "An endpoint to update an existing DhcpOption.", "operationId": "put_app_networkarchitecture_port_http_command_dhcpoption_dhcpoptioncommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DhcpOptionRequest" } } } }, "responses": { "204": { "description": "DhcpOption updated" }, "400": { "description": "Bad request" }, "404": { "description": "DhcpOption not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Dhcp Option" ], "summary": "An endpoint to delete an existing DhcpOption.", "operationId": "delete_app_networkarchitecture_port_http_command_dhcpoption_dhcpoptioncommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "DhcpOption deleted" }, "404": { "description": "DhcpOption not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-option/{dhcpOptionId}/dhcp-option-item": { "post": { "tags": [ "Dhcp Option Item" ], "summary": "An endpoint to create a new DhcpOptionItem.", "operationId": "post_app_networkarchitecture_port_http_command_dhcpoptionitem_dhcpoptionitemcommand_create", "parameters": [ { "name": "dhcpOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DhcpOptionItemRequest" } } } }, "responses": { "201": { "description": "DhcpOptionItem has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-option/{dhcpOptionId}/dhcp-option-item/{id}": { "get": { "tags": [ "Dhcp Option Item" ], "summary": "An endpoint to retrieve DhcpOptionItem details.", "operationId": "get_app_networkarchitecture_port_http_query_dhcpoptionitem_dhcpoptionitemquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "dhcpOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Single DhcpOptionItem object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewDhcpOptionItemResponse" } } } }, "404": { "description": "DhcpOptionItem not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Dhcp Option Item" ], "summary": "An endpoint to update an existing DhcpOptionItem.", "operationId": "put_app_networkarchitecture_port_http_command_dhcpoptionitem_dhcpoptionitemcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "dhcpOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DhcpOptionItemRequest" } } } }, "responses": { "204": { "description": "DhcpOptionItem updated" }, "400": { "description": "Bad request" }, "404": { "description": "DhcpOptionItem not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Dhcp Option Item" ], "summary": "An endpoint to delete an existing DhcpOptionItem.", "operationId": "delete_app_networkarchitecture_port_http_command_dhcpoptionitem_dhcpoptionitemcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "dhcpOptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "DhcpOptionItem deleted" }, "404": { "description": "DhcpOptionItem not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-whitelist/{id}": { "get": { "tags": [ "DHCP Whitelist" ], "summary": "An endpoint to retrieve DHCP whitelist details.", "operationId": "get_app_networkarchitecture_port_http_query_dhcpwhitelist_dhcpwhitelistquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single DHCP whitelist object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewDhcpWhitelistResponse" } } } }, "404": { "description": "DHCP whitelist not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "DHCP Whitelist" ], "summary": "An endpoint to update an existing DHCP Whitelist.", "operationId": "put_app_networkarchitecture_port_http_command_dhcpwhitelist_dhcpwhitelistcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DhcpWhitelistRequest" } } } }, "responses": { "204": { "description": "DHCP Whitelist has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "DHCP Whitelist not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "DHCP Whitelist" ], "summary": "An endpoint to delete an existing DHCP Whitelist.", "operationId": "delete_app_networkarchitecture_port_http_command_dhcpwhitelist_dhcpwhitelistcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "DHCP Whitelist has been deleted" }, "404": { "description": "DHCP Whitelist not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-whitelist": { "post": { "tags": [ "DHCP Whitelist" ], "summary": "An endpoint to create a new DHCP Whitelist.", "operationId": "post_app_networkarchitecture_port_http_command_dhcpwhitelist_dhcpwhitelistcommand_create", "requestBody": { "description": "Request to create a new DHCP Whitelist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DhcpWhitelistRequest" } } } }, "responses": { "201": { "description": "DHCP Whitelist has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ip-address/{id}": { "get": { "tags": [ "Ip Address" ], "summary": "An endpoint to retrieve IpAddress details.", "operationId": "get_app_networkarchitecture_port_http_query_ipaddress_ipaddressquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single IpAddress object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIpAddressResponse" } } } }, "404": { "description": "IpAddress not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Ip Address" ], "summary": "An endpoint to update an existing IpAddress.", "operationId": "put_app_networkarchitecture_port_http_command_ipaddress_ipaddresscommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAddressRequest" } } } }, "responses": { "204": { "description": "IpAddress updated" }, "400": { "description": "Bad request" }, "404": { "description": "IpAddress not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ip-address/release": { "patch": { "tags": [ "Ip Address" ], "summary": "An endpoint to remove lease.", "operationId": "patch_app_networkarchitecture_port_http_command_ipaddress_ipaddresscommand_removelease", "requestBody": { "description": "Request to remove lease for given Ip address and MAC address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveLeaseSubnetworkRequest" } } } }, "responses": { "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-group": { "post": { "tags": [ "Object Group" ], "summary": "An endpoint to create a new Object Group.", "operationId": "post_app_networkarchitecture_port_http_command_objectgroup_objectgroupcommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewObjectGroupRequest" } } } }, "responses": { "201": { "description": "Object Group has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-group/{id}": { "get": { "tags": [ "Object Group" ], "summary": "An endpoint to retrieve Object Group details.", "operationId": "get_app_networkarchitecture_port_http_query_objectgroup_objectgroupquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Object Group object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewObjectGroupResponse" } } } }, "404": { "description": "Object Group not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Object Group" ], "summary": "An endpoint to update an existing Object Group.", "operationId": "put_app_networkarchitecture_port_http_command_objectgroup_objectgroupcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditObjectGroupRequest" } } } }, "responses": { "204": { "description": "Object group updated" }, "400": { "description": "Bad request" }, "404": { "description": "Object group not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Object Group" ], "summary": "An endpoint to delete an existing object group.", "operationId": "delete_app_networkarchitecture_port_http_command_objectgroup_objectgroupcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Object group has been deleted" }, "404": { "description": "object group not found by given id" }, "409": { "description": "object group has relations and cannot be deleted" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-group/{id}/add-relations": { "put": { "tags": [ "Object Group" ], "summary": "An endpoint to add relations to existing Object Group.", "operationId": "put_app_networkarchitecture_port_http_command_objectgroup_objectgroupcommand_addrelation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRelationsObjectGroupRequest" } } } }, "responses": { "204": { "description": "Object group updated" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-group/{id}/remove-relations": { "put": { "tags": [ "Object Group" ], "summary": "An endpoint to remove relations from existing Object Group.", "operationId": "put_app_networkarchitecture_port_http_command_objectgroup_objectgroupcommand_removerelation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveRelationsObjectGroupRequest" } } } }, "responses": { "204": { "description": "Object group updated" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{networkDeviceId}/network-device-port/{id}": { "get": { "tags": [ "Port" ], "summary": "An endpoint to retrieve Port details.", "operationId": "get_app_networkarchitecture_port_http_query_port_portquery_view", "parameters": [ { "name": "networkDeviceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single port object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNetworkDevicePortResponse" } } } }, "404": { "description": "port not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Port" ], "summary": "An endpoint to update an existing Port.", "operationId": "put_app_networkarchitecture_port_http_command_port_portcommand_update", "parameters": [ { "name": "networkDeviceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortRequest" } } } }, "responses": { "204": { "description": "Port has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found port with given ID" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/printable-template": { "post": { "tags": [ "Printable Template" ], "summary": "An endpoint to create a new Printable Template.", "operationId": "post_app_networkarchitecture_port_http_command_printabletemplate_printabletemplatecommand_create", "requestBody": { "description": "Request to create a new LDAP Service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintableTemplateRequest" } } } }, "responses": { "201": { "description": "Printable Template created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/printable-template/{id}": { "get": { "tags": [ "Printable Template" ], "summary": "An endpoint to get an existing Printable Template.", "operationId": "get_app_networkarchitecture_port_http_query_printabletemplate_printabletemplatequery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Printable Template not found." }, "200": { "description": "Returns the result of the Entity Printable Template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewPrintableTemplateResponse" } } } } } }, "put": { "tags": [ "Printable Template" ], "summary": "An endpoint to update a PrintableTemplate.", "operationId": "put_app_networkarchitecture_port_http_command_printabletemplate_printabletemplatecommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to create a new Printable Template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintableTemplateRequest" } } } }, "responses": { "204": { "description": "Printable template has been updated" }, "404": { "description": "Printable template not found by given id" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Printable Template" ], "summary": "An endpoint to delete an existing Printable Template.", "operationId": "delete_app_networkarchitecture_port_http_command_printabletemplate_printabletemplatecommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Printable Template has been deleted" }, "404": { "description": "The Printable Template was not found for the given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/sector": { "post": { "tags": [ "Sector" ], "summary": "An endpoint to create a new Sector.", "operationId": "post_app_networkarchitecture_port_http_command_sector_sectorcommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSectorRequest" } } } }, "responses": { "201": { "description": "Sector has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/sector/{id}": { "get": { "tags": [ "Sector" ], "summary": "An endpoint to retrieve Sector details.", "operationId": "get_app_networkarchitecture_port_http_query_sector_sectorquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single sector object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSectorResponse" } } } }, "404": { "description": "sector not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Sector" ], "summary": "An endpoint to update an existing Sector.", "operationId": "put_app_networkarchitecture_port_http_command_sector_sectorcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditSectorRequest" } } } }, "responses": { "204": { "description": "Sector has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found sector with given ID" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Sector" ], "summary": "An endpoint to delete an existing sector.", "operationId": "delete_app_networkarchitecture_port_http_command_sector_sectorcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Sector has been deleted" }, "404": { "description": "Sector not found with given ID" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork": { "post": { "tags": [ "Subnetwork" ], "summary": "An endpoint to create a new Subnetwork.", "operationId": "post_app_networkarchitecture_port_http_command_subnetwork_subnetworkcommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSubnetworkRequest" } } } }, "responses": { "201": { "description": "Subnetwork has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/{id}": { "get": { "tags": [ "Subnetwork" ], "summary": "An endpoint to retrieve Subnetwork details.", "operationId": "get_app_networkarchitecture_port_http_query_subnetwork_subnetworkquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Subnetwork object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSubnetworkResponse" } } } }, "404": { "description": "Subnetwork not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Subnetwork" ], "summary": "An endpoint to update an existing Subnetwork.", "operationId": "put_app_networkarchitecture_port_http_command_subnetwork_subnetworkcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditSubnetworkRequest" } } } }, "responses": { "204": { "description": "Subnetwork updated" }, "400": { "description": "Bad request" }, "404": { "description": "Subnetwork not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Subnetwork" ], "summary": "An endpoint to delete an existing Subnetwork.", "operationId": "delete_app_networkarchitecture_port_http_command_subnetwork_subnetworkcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Subnetwork deleted" }, "404": { "description": "Subnetwork not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/{id}/create-ip-address": { "put": { "tags": [ "Subnetwork" ], "summary": "An endpoint to generate Subnetwork's IpAddresses.", "operationId": "put_app_networkarchitecture_port_http_command_subnetwork_subnetworkcommand_generateipaddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSubnetworkIpAddressesRequest" } } } }, "responses": { "201": { "description": "Subnetwork's IP Addresses has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/{id}/migrate": { "put": { "tags": [ "Subnetwork" ], "summary": "An endpoint to migrate an existing Subnetwork to a new CIDR.", "operationId": "put_app_networkarchitecture_port_http_command_subnetwork_subnetworkcommand_migrate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrateSubnetworkRequest" } } } }, "responses": { "204": { "description": "Subnetwork migrated" }, "400": { "description": "Bad request" }, "404": { "description": "Subnetwork not found by given ID" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/{id}/resize": { "put": { "tags": [ "Subnetwork" ], "summary": "An endpoint to resize an existing Subnetwork by changing its CIDR.", "operationId": "put_app_networkarchitecture_port_http_command_subnetwork_subnetworkcommand_resize", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResizeSubnetworkRequest" } } } }, "responses": { "204": { "description": "Subnetwork resized" }, "400": { "description": "Bad request" }, "404": { "description": "Subnetwork not found by given ID" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/release": { "patch": { "tags": [ "Subnetwork" ], "summary": "An endpoint to remove lease.", "operationId": "patch_app_networkarchitecture_port_http_command_subnetwork_subnetworkcommand_removelease", "requestBody": { "description": "Request to remove lease for given Ip address and MAC address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveLeaseSubnetworkRequest" } } } }, "responses": { "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vlan": { "post": { "tags": [ "VLAN" ], "summary": "An endpoint to create a new VLAN.", "operationId": "post_app_networkarchitecture_port_http_command_vlan_vlancommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanRequest" } } } }, "responses": { "201": { "description": "Vlan created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vlan/{id}": { "get": { "tags": [ "VLAN" ], "summary": "An endpoint to retrieve Vlan details.", "operationId": "get_app_networkarchitecture_port_http_query_vlan_vlanquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Vlan object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewVlanResponse" } } } }, "404": { "description": "Vlan not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "VLAN" ], "summary": "An endpoint to update an existing VLAN.", "operationId": "put_app_networkarchitecture_port_http_command_vlan_vlancommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanRequest" } } } }, "responses": { "204": { "description": "Vlan updated" }, "400": { "description": "Bad request" }, "404": { "description": "Vlan not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "VLAN" ], "summary": "An endpoint to delete an existing VLAN.", "operationId": "delete_app_networkarchitecture_port_http_command_vlan_vlancommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Vlan deleted" }, "404": { "description": "Vlan not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/wifi-network": { "post": { "tags": [ "Wifi Network" ], "summary": "An endpoint to create a new Wifi Network.", "operationId": "post_app_networkarchitecture_port_http_command_wifinetwork_wifinetworkcommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WifiNetworkRequest" } } } }, "responses": { "201": { "description": "Created new Wifi Network" }, "400": { "description": "Incorrect create payload!" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/wifi-network/{id}": { "get": { "tags": [ "Wifi Network" ], "summary": "An endpoint to retrieve Wifi Network details.", "operationId": "get_app_networkarchitecture_port_http_query_wifinetwork_wifinetworkquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "400": { "description": "Bad request" }, "404": { "description": "Wifi Network not found" }, "200": { "description": "Result of searching data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewWifiNetworkResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Wifi Network" ], "summary": "An endpoint to update a WifiNetwork.", "operationId": "put_app_networkarchitecture_port_http_command_wifinetwork_wifinetworkcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WifiNetworkRequest" } } } }, "responses": { "204": { "description": "Updated existing Wifi Network" }, "404": { "description": "Wifi Network not found" }, "400": { "description": "Bad request" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Wifi Network" ], "summary": "An endpoint to delete an existing WifiNetwork.", "operationId": "delete_app_networkarchitecture_port_http_command_wifinetwork_wifinetworkcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Deleted Wifi Network" }, "404": { "description": "Wifi Network not found!" }, "409": { "description": "Cannot delete object because it is used in other objects" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/color-identifier/list": { "post": { "tags": [ "Color Identifier" ], "summary": "An endpoint to build and search color identifier table.", "operationId": "post_app_networkarchitecture_port_http_query_coloridentifier_coloridentifierquery_list", "requestBody": { "description": "JSON object containing data to search for Color Identifier.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListColorIdentifierResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/color-identifier/mini-list": { "post": { "tags": [ "Color Identifier" ], "summary": "An endpoint to build and search color identifier mini list.", "operationId": "post_app_networkarchitecture_port_http_query_coloridentifier_coloridentifierquery_minilist", "requestBody": { "description": "JSON object containing data to search for Users.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListColorIdentifierResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/dhcp-option/list": { "post": { "tags": [ "Dhcp Option" ], "summary": "An endpoint to build and search DhcpOption table.", "operationId": "post_app_networkarchitecture_port_http_query_dhcpoption_dhcpoptionquery_list", "requestBody": { "description": "JSON object containing data to search for DhcpOption.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of DhcpOption's search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListDhcpOptionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-option/mini-list": { "post": { "tags": [ "Dhcp Option" ], "summary": "Endpoint for searching the mini DhcpOption list.", "operationId": "post_app_networkarchitecture_port_http_query_dhcpoption_dhcpoptionquery_minilist", "requestBody": { "description": "JSON object containing data to search for DhcpOption.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of DhcpOption's search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpOptionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-option/{dhcpOptionId}/dhcp-option-item/list": { "post": { "tags": [ "Dhcp Option Item" ], "summary": "An endpoint to build and search DhcpOptionItem table.", "operationId": "post_app_networkarchitecture_port_http_query_dhcpoptionitem_dhcpoptionitemquery_list", "parameters": [ { "name": "dhcpOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for DhcpOptionItem.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of DhcpOptionItem's search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListDhcpOptionItemResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-option/{dhcpOptionId}/dhcp-option-item/mini-list": { "post": { "tags": [ "Dhcp Option Item" ], "summary": "Endpoint for searching the mini DhcpOptionItem list.", "operationId": "post_app_networkarchitecture_port_http_query_dhcpoptionitem_dhcpoptionitemquery_minilist", "parameters": [ { "name": "dhcpOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object containing data to search for DhcpOptionItem.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of DhcpOptionItem's search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpOptionItemResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-whitelist/list": { "post": { "tags": [ "DHCP Whitelist" ], "summary": "An endpoint to build and search DHCP Whitelists table.", "operationId": "post_app_networkarchitecture_port_http_query_dhcpwhitelist_dhcpwhitelistquery_list", "requestBody": { "description": "JSON object containing data to search for DHCP Whitelists.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of DHCP Whitelists search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListDhcpWhitelistResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/dhcp-whitelist/mini-list": { "post": { "tags": [ "DHCP Whitelist" ], "summary": "Endpoint for searching the mini DHCP Whitelists list.", "operationId": "post_app_networkarchitecture_port_http_query_dhcpwhitelist_dhcpwhitelistquery_minilist", "requestBody": { "description": "JSON object containing data to search for DHCP Whitelists.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of DHCP whitelist search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpWhitelistResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ip-address/list": { "post": { "tags": [ "Ip Address" ], "summary": "An endpoint to build and search IpAddress table.", "operationId": "post_app_networkarchitecture_port_http_query_ipaddress_ipaddressquery_list", "requestBody": { "description": "JSON object containing data to search for IpAddress.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of IpAddress's search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListIpAddressResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ip-address/mini-list": { "post": { "tags": [ "Ip Address" ], "summary": "Endpoint for searching the mini IpAddress list.", "operationId": "post_app_networkarchitecture_port_http_query_ipaddress_ipaddressquery_minilist", "requestBody": { "description": "JSON object containing data to search for IpAddress.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of IpAddress's search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListIpAddressResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-group/list": { "post": { "tags": [ "Object Group" ], "summary": "An endpoint to build and search object group table.", "operationId": "post_app_networkarchitecture_port_http_query_objectgroup_objectgroupquery_list", "requestBody": { "description": "JSON object containing data to search for object groups.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of object groups search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListObjectGroupResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/object-group/mini-list": { "post": { "tags": [ "Object Group" ], "summary": "Endpoint for searching the mini object group list.", "operationId": "post_app_networkarchitecture_port_http_query_objectgroup_objectgroupquery_minilist", "requestBody": { "description": "JSON object containing data to search for Object groups.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Object group's search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{networkDeviceId}/network-device-port/list": { "post": { "tags": [ "Port" ], "summary": "An endpoint to build and search Ports table.", "operationId": "post_app_networkarchitecture_port_http_query_port_portquery_list", "parameters": [ { "name": "networkDeviceId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for ports.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of ports search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListNetworkDevicePortResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{networkDeviceId}/network-device-port/mini-list": { "post": { "tags": [ "Port" ], "summary": "Endpoint for searching the mini Ports list.", "operationId": "post_app_networkarchitecture_port_http_query_port_portquery_minilist", "parameters": [ { "name": "networkDeviceId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "JSON object containing data to search for ports.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of sectors search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDevicePortResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/printable-template/list": { "post": { "tags": [ "Printable Template" ], "summary": "An endpoint to build and search Printable Template table.", "operationId": "post_app_networkarchitecture_port_http_query_printabletemplate_printabletemplatequery_list", "requestBody": { "description": "JSON object containing data to search for Printable Templates.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Printable Templates search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListPrintableTemplateResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/printable-template/mini-list": { "post": { "tags": [ "Printable Template" ], "summary": "An endpoint to build and search Printable Template mini list.", "operationId": "post_app_networkarchitecture_port_http_query_printabletemplate_printabletemplatequery_minilist", "requestBody": { "description": "JSON object containing data to search for Printable Templates.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Printable Templates search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListPrintableTemplatesResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" } } } }, "/api/v3/sector/list": { "post": { "tags": [ "Sector" ], "summary": "An endpoint to build and search Sectors table.", "operationId": "post_app_networkarchitecture_port_http_query_sector_sectorquery_list", "requestBody": { "description": "JSON object containing data to search for sectors.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of sectors search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListSectorResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/sector/mini-list": { "post": { "tags": [ "Sector" ], "summary": "Endpoint for searching the mini Sectors list.", "operationId": "post_app_networkarchitecture_port_http_query_sector_sectorquery_minilist", "requestBody": { "description": "JSON object containing data to search for sectors.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of sectors search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListSectorResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/{id}/dhcp-pool/{systemNodeId}": { "get": { "tags": [ "Subnetwork" ], "summary": "An endpoint to retrieve a DHCP pool list for Subnetwork", "operationId": "get_app_networkarchitecture_port_http_query_subnetwork_subnetworkdhcppool_viewdhcppool", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "systemNodeId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Returns the result of dynamic and static dhcp usage", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DhcpUsageResponse" } } }, "type": "object" } } } }, "404": { "description": "Subnetwork not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/list": { "post": { "tags": [ "Subnetwork" ], "summary": "An endpoint to build and search Subnetworks table.", "operationId": "post_app_networkarchitecture_port_http_query_subnetwork_subnetworkquery_list", "requestBody": { "description": "JSON object containing data to search for Subnetworks.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Subnetwork's search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListSubnetworkResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/subnetwork/mini-list": { "post": { "tags": [ "Subnetwork" ], "summary": "Endpoint for searching the mini Subnetwork list.", "operationId": "post_app_networkarchitecture_port_http_query_subnetwork_subnetworkquery_minilist", "requestBody": { "description": "JSON object containing data to search for Subnetworks.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Subnetwork's search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListSubnetworkResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vlan/list": { "post": { "tags": [ "VLAN" ], "summary": "An endpoint to build and search Vlans table.", "operationId": "post_app_networkarchitecture_port_http_query_vlan_vlanquery_list", "requestBody": { "description": "JSON object containing data to search for VLANs.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of VLAN's search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListVlansResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vlan/mini-list": { "post": { "tags": [ "VLAN" ], "summary": "Endpoint for searching the mini Vlan list.", "operationId": "post_app_networkarchitecture_port_http_query_vlan_vlanquery_minilist", "requestBody": { "description": "JSON object containing data to search for VLANs.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of VLAN's search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListVlanResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/wifi-network/list": { "post": { "tags": [ "Wifi Network" ], "summary": "An endpoint to build and search WifiNetworks table.", "operationId": "post_app_networkarchitecture_port_http_query_wifinetwork_wifinetworkquery_list", "requestBody": { "description": "JSON object containing data to search for Wifi Network.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "400": { "description": "Invalid search query data provided." }, "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListWifiNetworkResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/wifi-network/mini-list": { "post": { "tags": [ "Wifi Network" ], "summary": "Endpoint for searching the mini Wifi-Network list.", "operationId": "post_app_networkarchitecture_port_http_query_wifinetwork_wifinetworkquery_minilist", "requestBody": { "description": "JSON object containing data to search for Wifi Network.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "400": { "description": "Invalid search query data provided." }, "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListWifiNetworkResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/app/sponsor-activate": { "post": { "tags": [ "Captive Portal Sponsor" ], "summary": "An endpoint to activate Identity by Captive Portal Sponsor.", "operationId": "post_captive_portal_sponsor_activate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalSponsorIdentityActivationRequest" } } } }, "responses": { "200": { "description": "Identity activated" }, "400": { "description": "Incorrect activation payload" } } } }, "/api/v3/captive-portal/{id}": { "get": { "tags": [ "Captive Portal" ], "summary": "An endpoint to receive Captive Portal details.", "operationId": "get_app_networkobjects_port_http_query_captiveportal_captiveportalquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "View Captive Portal object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCaptivePortalResponse" } } } }, "404": { "description": "Captive Portal not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Captive Portal" ], "summary": "An endpoint to update Captive Portal", "operationId": "put_app_networkobjects_port_http_command_captiveportal_captiveportalcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an Captive Portal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalRequest" } } } }, "responses": { "204": { "description": "Captive Portal updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-object-group-config": { "post": { "tags": [ "Captive Portal Object Group Config" ], "summary": "An endpoint to assign Captive Portal Object Group Config", "operationId": "post_app_networkobjects_port_http_command_captiveportalobjectgroupconfig_captiveportalobjectgroupconfigcommand_create", "requestBody": { "description": "Request to update an Captive Portal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalObjectGroupConfigRequest" } } } }, "responses": { "201": { "description": "Captive Portal Object Group Config created successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-object-group-config/{id}": { "get": { "tags": [ "Captive Portal Object Group Config" ], "summary": "An endpoint to receive Captive Portal Object Group Config details.", "operationId": "get_app_networkobjects_port_http_query_captiveportalobjectgroupconfig_captiveportalobjectgroupconfigquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "View Captive Portal Object Group Config object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCaptivePortalObjectGroupConfigResponse" } } } }, "404": { "description": "Captive Portal Object Group Config not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Captive Portal Object Group Config" ], "summary": "An endpoint to assign Captive Portal Object Group Config", "operationId": "put_app_networkobjects_port_http_command_captiveportalobjectgroupconfig_captiveportalobjectgroupconfigcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an Captive Portal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalObjectGroupConfigRequest" } } } }, "responses": { "204": { "description": "Captive Portal Object Group Config created successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Captive Portal Object Group Config" ], "summary": "An endpoint to delete an existing Object Group Config to Captive Portal.", "operationId": "delete_app_networkobjects_port_http_command_captiveportalobjectgroupconfig_captiveportalobjectgroupconfigcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": " Captive Portal Object Group Config has been deleted" }, "404": { "description": "Not found Captive Portal Object Group Config " }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-registration-form": { "post": { "tags": [ "Captive Portal Registration Form" ], "operationId": "post_app_networkobjects_port_http_command_captiveportalregistrationform_captiveportalregistrationformcommand_create", "requestBody": { "description": "Create Captive Portal Registration Form", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalRegistrationFormRequest" } } } }, "responses": { "201": { "description": "Captive Portal Registration Form created successfully" }, "400": { "description": "Incorrect update payload" } } } }, "/api/v3/captive-portal-registration-form/{id}": { "get": { "tags": [ "Captive Portal Registration Form" ], "summary": "An endpoint to receive Captive Portal Registration Form details.", "operationId": "get_app_networkobjects_port_http_query_captiveportalregistrationform_captiveportalregistrationformquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "View Captive Portal Registration Form object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCaptivePortalRegistrationFormResponse" } } } }, "404": { "description": "Captive Portal Registration Form not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Captive Portal Registration Form" ], "operationId": "put_app_networkobjects_port_http_command_captiveportalregistrationform_captiveportalregistrationformcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Update Captive Portal Registration Form", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalRegistrationFormRequest" } } } }, "responses": { "204": { "description": "Captive Portal Registration Form created successfully" }, "400": { "description": "Incorrect update payload" } } }, "delete": { "tags": [ "Captive Portal Registration Form" ], "operationId": "delete_app_networkobjects_port_http_command_captiveportalregistrationform_captiveportalregistrationformcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": " Captive Portal Registration Form has been deleted" }, "404": { "description": "Not found Captive Portal Registration Form " } } } }, "/api/v3/captive-portal-sponsor": { "post": { "tags": [ "Captive Portal Sponsor" ], "summary": "An endpoint to create a new Captive portal sponsor.", "operationId": "post_app_networkobjects_port_http_command_captiveportalsponsor_captiveportalsponsorcommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalSponsorRequest" } } } }, "responses": { "201": { "description": "Captive portal sponsor has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-sponsor/{id}": { "get": { "tags": [ "Captive Portal Sponsor" ], "summary": "An endpoint to receive Captive Portal Sponsor details.", "operationId": "get_app_networkobjects_port_http_query_captiveportalsponsor_captiveportalsponsorquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "View Captive Portal Sponsor object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCaptivePortalSponsorResponse" } } } }, "404": { "description": "Captive Portal Sponsor not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Captive Portal Sponsor" ], "summary": "An endpoint to update an existing Captive portal sponsor.", "operationId": "put_app_networkobjects_port_http_command_captiveportalsponsor_captiveportalsponsorcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalSponsorRequest" } } } }, "responses": { "204": { "description": "Captive portal sponsor has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Captive portal sponsor" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Captive Portal Sponsor" ], "summary": "An endpoint to delete an existing Captive portal sponsor.", "operationId": "delete_app_networkobjects_port_http_command_captiveportalsponsor_captiveportalsponsorcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Captive portal sponsor has been deleted" }, "404": { "description": "Not found Captive portal sponsor" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-sponsor/activate": { "patch": { "tags": [ "Captive Portal Sponsor" ], "summary": "An endpoint to activate Identity by Captive Portal Sponsor.", "operationId": "patch_app_networkobjects_port_http_command_captiveportalsponsor_captiveportalsponsoridentityactivation_activate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptivePortalSponsorIdentityActivationRequest" } } } }, "responses": { "200": { "description": "Identity activated" }, "400": { "description": "Incorrect activation payload" } } } }, "/api/v3/config/creator-profiling": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Creator Profiling details.", "operationId": "get_app_networkobjects_port_http_query_creatorprofiling_creatorprofilingquery_view", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View Creator Profiling object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorProfilingResponse" } } } }, "404": { "description": "Creator Profiling not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator Profiling", "operationId": "put_app_networkobjects_port_http_command_creatorprofiling_creatorprofilingcommand_update", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to update an Creator Profiling", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorProfilingRequest" } } } }, "responses": { "204": { "description": "Creator Profiling updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device": { "post": { "tags": [ "Endpoint Device" ], "summary": "An endpoint to create a new Endpoint Device.", "operationId": "post_app_networkobjects_port_http_command_endpointdevice_endpointdevice_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEndpointDeviceRequest" } } } }, "responses": { "201": { "description": "Endpoint Device has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/{id}": { "get": { "tags": [ "Endpoint Device" ], "summary": "An endpoint to view Endpoint device.", "operationId": "get_app_networkobjects_port_http_query_endpointdevice_endpointdevicequery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Endpoint device object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewEndpointDeviceResponse" } } } }, "404": { "description": "Not found Endpoint device." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Endpoint Device" ], "summary": "An endpoint to update an existing Endpoint Device.", "operationId": "put_app_networkobjects_port_http_command_endpointdevice_endpointdevice_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditEndpointDeviceRequest" } } } }, "responses": { "204": { "description": "Endpoint Device has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Endpoint Device" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Endpoint Device" ], "summary": "An endpoint to delete an existing Endpoint Device.", "operationId": "delete_app_networkobjects_port_http_command_endpointdevice_endpointdevice_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Endpoint Device has been deleted" }, "404": { "description": "Not found Endpoint Device" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/identities-configuration": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Identities Configuration details.", "operationId": "get_app_networkobjects_port_http_query_identitiesconfiguration_identitiesconfigurationquery_view", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View Identities Configuration object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIdentitiesConfigurationResponse" } } } }, "404": { "description": "Identities Configuration not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Identities Configuration", "operationId": "put_app_networkobjects_port_http_command_identitiesconfiguration_identitiesconfigurationcommand_update", "requestBody": { "description": "Request to update an Identities Configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentitiesConfigurationRequest" } } } }, "responses": { "204": { "description": "Identities Configuration updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/{id}/change-password": { "patch": { "tags": [ "Identity" ], "summary": "An endpoint to change password.", "operationId": "patch_app_networkobjects_port_http_command_identity_identitychangepassword_changepassword", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to set a new password", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeIdentityPasswordRequest" } } } }, "responses": { "204": { "description": "A password successfully updated!" }, "400": { "description": "Password change not allowed for this identity." } } } }, "/api/v3/identity-common/{id}/mfa/refresh": { "patch": { "tags": [ "Identity" ], "summary": "An endpoint to refresh mfa secret", "operationId": "patch_app_networkobjects_port_http_command_identity_identitycommand_refreshmfa", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to refresh mfa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityRefreshMfaRequest" } } } }, "responses": { "204": { "description": "Mfa secret has been refreshed" }, "404": { "description": "Identity not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-external/{id}/mfa/refresh": { "patch": { "tags": [ "Identity" ], "summary": "An endpoint to refresh mfa secret", "operationId": "patch_app_networkobjects_port_http_command_identity_identitycommand_refreshmfa_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to refresh mfa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityRefreshMfaRequest" } } } }, "responses": { "204": { "description": "Mfa secret has been refreshed" }, "404": { "description": "Identity not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-voucher/{id}/mfa/refresh": { "patch": { "tags": [ "Identity" ], "summary": "An endpoint to refresh mfa secret", "operationId": "patch_app_networkobjects_port_http_command_identity_identitycommand_refreshmfa_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to refresh mfa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityRefreshMfaRequest" } } } }, "responses": { "204": { "description": "Mfa secret has been refreshed" }, "404": { "description": "Identity not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-common": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to create a new Common Identity.", "operationId": "post_app_networkobjects_port_http_command_identity_identitycommoncommand_commoncreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIdentityRequest" } } } }, "responses": { "201": { "description": "Identity has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-common/multi-create": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to create multi a new Common Identity.", "operationId": "post_app_networkobjects_port_http_command_identity_identitycommoncommand_commonmulticreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityCommonMultiCreateRequest" } } } }, "responses": { "202": { "description": "A queue has been created to send emails", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-common/{id}": { "get": { "tags": [ "Identity" ], "summary": "An endpoint to retrieve Common Identity details.", "operationId": "get_app_networkobjects_port_http_query_identity_identitycommonview_viewcommon", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Identity object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIdentityResponse" } } } }, "404": { "description": "Identity not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Identity" ], "summary": "An endpoint to update an existing Common Identity.", "operationId": "put_app_networkobjects_port_http_command_identity_identitycommoncommand_commonupdate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditIdentityRequest" } } } }, "responses": { "204": { "description": "Identity has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Identity" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Identity" ], "summary": "An endpoint to delete an existing Common Identity.", "operationId": "delete_app_networkobjects_port_http_command_identity_identitycommoncommand_commondelete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Identity has been deleted" }, "404": { "description": "Not found Identity" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-external": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to create a new External Identity.", "operationId": "post_app_networkobjects_port_http_command_identity_identityexternalcommand_externalcreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIdentityRequest" } } } }, "responses": { "201": { "description": "Identity has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-external/{id}": { "get": { "tags": [ "Identity" ], "summary": "An endpoint to retrieve External Identity details.", "operationId": "get_app_networkobjects_port_http_query_identity_identityexternalview_viewexternal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Identity object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIdentityResponse" } } } }, "404": { "description": "Identity not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Identity" ], "summary": "An endpoint to update an existing External Identity.", "operationId": "put_app_networkobjects_port_http_command_identity_identityexternalcommand_externalupdate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditIdentityRequest" } } } }, "responses": { "204": { "description": "Identity has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Identity" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Identity" ], "summary": "An endpoint to delete an existing External Identity.", "operationId": "delete_app_networkobjects_port_http_command_identity_identityexternalcommand_externaldelete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Identity has been deleted" }, "404": { "description": "Not found Identity" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/reset-password/request": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to request reset password token.", "operationId": "post_app_networkobjects_port_http_command_identity_identityresetpassword_resetpasswordrequest", "requestBody": { "description": "Request to request reset password", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityResetPasswordTokenRequest" } } } }, "responses": { "201": { "description": "A new reset password token generated, notification sent!" }, "400": { "description": "Bad request" } } } }, "/api/v3/identity/reset-password/confirm": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to set a new password.", "operationId": "post_app_networkobjects_port_http_command_identity_identityresetpassword_newpassword", "requestBody": { "description": "Request to set a new password", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIdentityPasswordRequest" } } } }, "responses": { "204": { "description": "A password successfully updated!" }, "401": { "description": "Invalid reset password credentials." } } } }, "/api/v3/identity-voucher": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to create a new Voucher Identity.", "operationId": "post_app_networkobjects_port_http_command_identity_identityvouchercommand_vouchercreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIdentityRequest" } } } }, "responses": { "201": { "description": "Identity has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-voucher/multi-create": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to create multi a new Voucher Identity.", "operationId": "post_app_networkobjects_port_http_command_identity_identityvouchercommand_vouchermulticreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityVoucherMultiCreateRequest" } } } }, "responses": { "202": { "description": "A queue has been created to send emails", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-voucher/{id}": { "get": { "tags": [ "Identity" ], "summary": "An endpoint to retrieve Voucher Identity details.", "operationId": "get_app_networkobjects_port_http_query_identity_identityvoucherview_viewvoucher", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Identity object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIdentityResponse" } } } }, "404": { "description": "Identity not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Identity" ], "summary": "An endpoint to update an existing Voucher Identity.", "operationId": "put_app_networkobjects_port_http_command_identity_identityvouchercommand_voucherupdate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditIdentityRequest" } } } }, "responses": { "204": { "description": "Identity has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found Identity" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Identity" ], "summary": "An endpoint to delete an existing Voucher Identity.", "operationId": "delete_app_networkobjects_port_http_command_identity_identityvouchercommand_voucherdelete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Identity has been deleted" }, "404": { "description": "Not found Identity" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/auth": { "post": { "tags": [ "Identity Authentication" ], "summary": "An endpoint to authenticate identity.", "operationId": "post_app_networkobjects_port_http_command_identityauthentication_identityauthentication_authenticate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateIdentityRequest" } } } }, "responses": { "200": { "description": "Identity successfully authenticated" }, "206": { "description": "MFA required for login", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityMfaRequiredForLoginResponse" } } } }, "400": { "description": "Invalid payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/network-auth": { "post": { "tags": [ "Identity Authentication" ], "operationId": "post_app_networkobjects_port_http_command_identityauthentication_identityauthentication_networkauthenticate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAuthenticateIdentityRequest" } } } }, "responses": { "200": { "description": "Network authentication succeeded" }, "400": { "description": "Invalid payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/mfa": { "post": { "tags": [ "Identity Authentication" ], "summary": "An endpoint to validate an MFA token", "operationId": "post_app_networkobjects_port_http_command_identityauthentication_identitymfaauthentication_mfa", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaIdentityAuthenticationRequest" } } } }, "responses": { "200": { "description": "Successful authentication", "content": { "application/json": { "schema": { "properties": { "token": { "type": "string", "example": "jwt token" } }, "type": "object" } } } }, "400": { "description": "Incorrect payload" }, "401": { "description": "Missing CSRF", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid CSRF Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/send-token": { "post": { "tags": [ "Identity Authentication" ], "summary": "An endpoint that sends an MFA token to the identity", "operationId": "post_app_networkobjects_port_http_command_identityauthentication_identitymfaauthentication_sendtokentouser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMfaIdentityAuthenticationTokenRequest" } } } }, "responses": { "204": { "description": "MFA token successfully sent to the identity" }, "400": { "description": "Incorrect payload" }, "401": { "description": "Missing CSRF", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid CSRF Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/register": { "post": { "tags": [ "Identity Authentication" ], "summary": "An endpoint to register identity.", "operationId": "post_app_networkobjects_port_http_command_identityauthentication_identityregistration_captiveportalregister", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterIdentityRequest" } } } }, "responses": { "200": { "description": "Network authentication succeeded" }, "400": { "description": "Invalid payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address": { "post": { "tags": [ "Mac Address" ], "summary": "An endpoint to create a new Mac Address.", "operationId": "post_app_networkobjects_port_http_command_macaddress_macaddresscommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacAddressRequest" } } } }, "responses": { "201": { "description": "Mac address has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address/{id}": { "get": { "tags": [ "Mac Address" ], "summary": "An endpoint to retrieve Mac Address details.", "operationId": "get_app_networkobjects_port_http_query_macaddress_macaddressquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Mac Address object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewMacAddressResponse" } } } }, "404": { "description": "Not found mac address" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Mac Address" ], "summary": "An endpoint to update an existing Mac Address.", "operationId": "put_app_networkobjects_port_http_command_macaddress_macaddresscommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacAddressRequest" } } } }, "responses": { "204": { "description": "Mac address has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Not found mac address" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Mac Address" ], "summary": "An endpoint to delete an existing Mac Address.", "operationId": "delete_app_networkobjects_port_http_command_macaddress_macaddresscommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Mac Address has been deleted" }, "404": { "description": "Not found Mac Address" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address/{id}/wake": { "patch": { "tags": [ "Mac Address" ], "summary": "An endpoint to sends a Wake-on-LAN (WoL) magic packet to a specified MAC address", "operationId": "patch_app_networkobjects_port_http_command_macaddress_macaddresscommand_wake", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacAddressWakeOnLanRequest" } } } }, "responses": { "201": { "description": "WoL magic packet has been sent" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-scout": { "get": { "tags": [ "Nacview Scout" ], "summary": "An endpoint to retrieve Nacview Scout details.", "operationId": "get_app_networkobjects_port_http_query_nacviewscout_nacviewscoutquery_view", "responses": { "200": { "description": "View Nacview Scout object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNacviewScoutResponse" } } } }, "404": { "description": "Nacview Scout not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Nacview Scout" ], "summary": "An endpoint to update Nacview Scout", "operationId": "put_app_networkobjects_port_http_command_nacviewscout_nacviewscoutcommand_update", "requestBody": { "description": "Request to update an Nacview Scout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NacviewScoutRequest" } } } }, "responses": { "204": { "description": "Nacview Scout updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-scout/object-group-config": { "post": { "tags": [ "Nacview Scout Object Group Config" ], "summary": "An endpoint to create a new Nacview Scout Object Group Config.", "operationId": "post_network-deviceapp_networkobjects_port_http_command_nacviewscoutobjectgroupconfig_nacviewscoutobjectgroupconfigcommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NacviewScoutObjectGroupConfigRequest" } } } }, "responses": { "201": { "description": "Nacview Scout Object Group Config has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-scout/object-group-config/{id}": { "get": { "tags": [ "Nacview Scout Object Group Config" ], "summary": "An endpoint to retrieve Nacview Scout Object Group Config details.", "operationId": "get_app_networkobjects_port_http_query_nacviewscoutobjectgroupconfig_nacviewscoutobjectgroupconfigquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Nacview Scout Object Group Config object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNacviewScoutObjectGroupConfigResponse" } } } }, "404": { "description": "Object not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Nacview Scout Object Group Config" ], "summary": "An endpoint to update an existing Nacview Scout Object Group Config.", "operationId": "put_network-deviceapp_networkobjects_port_http_command_nacviewscoutobjectgroupconfig_nacviewscoutobjectgroupconfigcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NacviewScoutObjectGroupConfigRequest" } } } }, "responses": { "201": { "description": "Nacview Scout Object Group Config has been updated" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Nacview Scout Object Group Config" ], "summary": "An endpoint to delete an existing Nacview Scout Object Group Config.", "operationId": "delete_network-deviceapp_networkobjects_port_http_command_nacviewscoutobjectgroupconfig_nacviewscoutobjectgroupconfigcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Nacview Scout Object Group Config has been removed" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/download-config": { "patch": { "tags": [ "Network Device" ], "summary": "An endpoint to download network configuration", "operationId": "patch_network-deviceapp_networkobjects_port_http_command_networkdevice_downloadnetworkdeviceconfig_create", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Download network device configuration", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "example": "a981a6d0-da0f-4d27-ba3c-50740d03308b" } }, "type": "object" } } } }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/retention": { "patch": { "tags": [ "Network Device" ], "summary": "An endpoint to retention old network-device-configs", "operationId": "patch_network-deviceapp_networkobjects_port_http_command_networkdevice_downloadnetworkdeviceconfig_retention", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Download network device configuration" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/status-check": { "post": { "tags": [ "Network Device" ], "summary": "Run async network device status check", "operationId": "post_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdevicecheckstatusapicommand__invoke", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "202": { "description": "Status check request registered", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Incorrect payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device": { "post": { "tags": [ "Network Device" ], "summary": "An endpoint to create a new Network device.", "operationId": "post_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdevice_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDeviceRequest" } } } }, "responses": { "201": { "description": "Network device has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}": { "get": { "tags": [ "Network Device" ], "summary": "An endpoint to view Network device.", "operationId": "get_network-deviceapp_networkobjects_port_http_query_networkdevice_networkdevice_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Network device object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNetworkDeviceResponse" } } } }, "404": { "description": "Not found Network device." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Network Device" ], "summary": "An endpoint to update an existing network device.", "operationId": "put_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdevice_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDeviceRequest" } } } }, "responses": { "201": { "description": "Network device has been updated" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Network Device" ], "summary": "An endpoint to delete an existing network device.", "operationId": "delete_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdevice_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Network device has been removed" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/clone": { "post": { "tags": [ "Network Device" ], "summary": "An endpoint to clone a Network device.", "operationId": "post_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdevice_clone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+", "example": 1 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneNetworkDeviceRequest" } } } }, "responses": { "201": { "description": "Network device has been cloned" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/batch-commands": { "post": { "tags": [ "Network Device" ], "summary": "Execute Commands on Network Device", "operationId": "post_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdeviceexecuteapicommand_executebatchcommands", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDeviceExecuteApiCommandRequest" } } } }, "responses": { "201": { "description": "Result of executed commands", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/ssh/init": { "patch": { "tags": [ "Network Device" ], "summary": "An endpoint to init authentication for WebSSH.", "operationId": "patch_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdeviceinitwebssh_init", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Created WebSSH data for device credential", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "example": "a981a6d0-da0f-4d27-ba3c-50740d03308b" } }, "type": "object" } } } }, "400": { "description": "Missing NetworkDevice" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/reauthorize": { "patch": { "tags": [ "Network Device" ], "summary": "An endpoint to reauthorize device.", "operationId": "patch_network-deviceapp_networkobjects_port_http_command_networkdevice_networkdevicereauth_reauthorize", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDeviceReauthRequest" } } } }, "responses": { "202": { "description": "Network device has been updated", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Incorrect create payload" }, "404": { "description": "Not found client mac" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/profiling-definition": { "post": { "tags": [ "Profiling Definition" ], "summary": "An endpoint to create a new ProfilingDefinition.", "operationId": "post_app_networkobjects_port_http_command_profilingdefinition_profilingdefinitioncommand_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilingDefinitionRequest" } } } }, "responses": { "201": { "description": "ProfilingDefinition has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/profiling-definition/{id}": { "get": { "tags": [ "Profiling Definition" ], "summary": "An endpoint to retrieve Profiling Definition details.", "operationId": "get_app_networkobjects_port_http_query_profilingdefinition_profilingdefinitionquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Profiling Definition object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewProfilingDefinitionResponse" } } } }, "404": { "description": "Not found profiling definition with provided id." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Profiling Definition" ], "summary": "An endpoint to update an existing ProfilingDefinition.", "operationId": "put_app_networkobjects_port_http_command_profilingdefinition_profilingdefinitioncommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilingDefinitionRequest" } } } }, "responses": { "204": { "description": "ProfilingDefinition updated" }, "400": { "description": "Bad request" }, "404": { "description": "ProfilingDefinition not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Profiling Definition" ], "summary": "An endpoint to delete an existing ProfilingDefinition.", "operationId": "delete_app_networkobjects_port_http_command_profilingdefinition_profilingdefinitioncommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "ProfilingDefinition deleted" }, "404": { "description": "ProfilingDefinition not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/profiling-definition/{id}/rules": { "put": { "tags": [ "Profiling Definition" ], "summary": "An endpoint to assign Profiling Definition Rules", "operationId": "put_app_networkobjects_port_http_command_profilingdefinition_profilingdefinitioncommand_assigninterfaces", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to assign Profiling Definition Rules", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignProfilingDefinitionRuleRequest" } } } }, "responses": { "204": { "description": "Profiling Definition Rules has been successfully assigned" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/reauth-device-credential": { "post": { "tags": [ "Reauth Device Credential" ], "summary": "An endpoint to create a new reauth device credential.", "operationId": "post_reauth-device-credentialapp_networkobjects_port_http_command_reauthdevicecredential_reauthdevicecredential_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReauthDeviceCredentialRequest" } } } }, "responses": { "201": { "description": "Reauth device credential has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/reauth-device-credential/{id}": { "get": { "tags": [ "Reauth Device Credential" ], "summary": "An endpoint to view reauth device credential.", "operationId": "get_reauth-device-credentialapp_networkobjects_port_http_query_reauthdevicecredential_reauthdevicecredentialquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single reauth device credential object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewReauthDeviceCredentialResponse" } } } }, "404": { "description": "Not found reauth device credential." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Reauth Device Credential" ], "summary": "An endpoint to update a new reauth device credential.", "operationId": "put_reauth-device-credentialapp_networkobjects_port_http_command_reauthdevicecredential_reauthdevicecredential_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReauthDeviceCredentialRequest" } } } }, "responses": { "201": { "description": "Reauth device credential has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Reauth Device Credential" ], "summary": "An endpoint to delete a existing reauth device credential.", "operationId": "delete_reauth-device-credentialapp_networkobjects_port_http_command_reauthdevicecredential_reauthdevicecredential_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Reauth device credential has been removed" }, "400": { "description": "Incorrect create payload" }, "409": { "description": "Cannot delete object because it is used in other objects" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal/code/{code}": { "get": { "tags": [ "Captive Portal" ], "summary": "An endpoint to receive Captive Portal details.", "operationId": "get_app_networkobjects_port_http_query_captiveportal_captiveportalquery_viewbycode", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View Captive Portal object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCaptivePortalResponse" } } } }, "404": { "description": "Captive Portal not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal/list": { "post": { "tags": [ "Captive Portal" ], "summary": "An endpoint to build and search Captive Portal table.", "operationId": "post_app_networkobjects_port_http_query_captiveportal_captiveportalquery_list", "requestBody": { "description": "JSON object containing data to search for Captive Portals.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portal search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListCaptivePortalResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal/mini-list": { "post": { "tags": [ "Captive Portal" ], "summary": "Endpoint for searching the Captive Portal list.", "operationId": "post_app_networkobjects_port_http_query_captiveportal_captiveportalquery_minilist", "requestBody": { "description": "JSON object containing data to search for Captive Portals.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portals search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal/{id}/default-identity": { "get": { "tags": [ "Captive Portal" ], "summary": "An endpoint to receive Captive Portal Default Identities details.", "operationId": "get_app_networkobjects_port_http_query_captiveportal_captiveportalquery_viewcaptiveportaldefaultidentity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "View Captive Portal object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewDefaultCaptivePortalIdentityResponse" } } } }, "404": { "description": "Captive Portal not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-object-group-config/list": { "post": { "tags": [ "Captive Portal Object Group Config" ], "summary": "An endpoint to build and search Captive Portal Object Group Config table.", "operationId": "post_app_networkobjects_port_http_query_captiveportalobjectgroupconfig_captiveportalobjectgroupconfigquery_list", "requestBody": { "description": "JSON object containing data to search for Captive Portal ObjectGroupConfig .", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portal ObjectGroupConfig search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListCaptivePortalObjectGroupConfigResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-object-group-config/mini-list": { "post": { "tags": [ "Captive Portal Object Group Config" ], "summary": "Endpoint for searching the Captive Portal Object Group Config list.", "operationId": "post_app_networkobjects_port_http_query_captiveportalobjectgroupconfig_captiveportalobjectgroupconfigquery_minilist", "requestBody": { "description": "JSON object containing data to search for Captive Portal Object Group Config.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portal Object Group Config search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalObjectGroupConfigResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-registration-form/list": { "post": { "tags": [ "Captive Portal Registration Form" ], "summary": "An endpoint to build and search Captive Portal Registration Form table.", "operationId": "post_app_networkobjects_port_http_query_captiveportalregistrationform_captiveportalregistrationformquery_list", "requestBody": { "description": "JSON object containing data to search for Captive Portal RegistrationForm .", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portal RegistrationForm search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListCaptivePortalRegistrationFormResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-registration-form/mini-list": { "post": { "tags": [ "Captive Portal Registration Form" ], "summary": "Endpoint for searching the Captive Portal Registration Form list.", "operationId": "post_app_networkobjects_port_http_query_captiveportalregistrationform_captiveportalregistrationformquery_minilist", "requestBody": { "description": "JSON object containing data to search for Captive Portal RegistrationForm .", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portal Registration Form search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalRegistrationFormResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-sponsor/list": { "post": { "tags": [ "Captive Portal Sponsor" ], "summary": "An endpoint to build and search Captive Portal Sponsor table.", "operationId": "post_app_networkobjects_port_http_query_captiveportalsponsor_captiveportalsponsorquery_list", "requestBody": { "description": "JSON object containing data to search for Captive Portal Sponsors.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portal Sponsor search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListCaptivePortalSponsorResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-sponsor/mini-list": { "post": { "tags": [ "Captive Portal Sponsor" ], "summary": "Endpoint for searching the Captive Portal Sponsor list.", "operationId": "post_app_networkobjects_port_http_query_captiveportalsponsor_captiveportalsponsorquery_minilist", "requestBody": { "description": "JSON object containing data to search for Captive Portal Sponsors.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Captive Portal Sponsors search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalSponsorResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/captive-portal-submit/{id}": { "get": { "tags": [ "Captive Portal" ], "summary": "An endpoint to receive Captive Portal details.", "operationId": "get_app_networkobjects_port_http_query_captiveportalsubmit_captiveportalsubmitquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "View Captive Portal Submit object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCaptivePortalSubmitResponse" } } } }, "404": { "description": "Captive Portal not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/{id}/graph/list": { "get": { "tags": [ "Endpoint Device" ], "summary": "Monitoring endpoint to view list of graphs for selected endpoint device.", "operationId": "get_app_networkobjects_port_http_query_endpointdevice_endpointdevicemonitoring_listgraphendpointdevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "return list of graphs", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of network graphs search results.", "type": "array", "items": { "$ref": "#/components/schemas/EndpointDeviceGraphListResponse" } } }, "type": "object" } } } }, "404": { "description": "Endpoint device not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/{id}/graph/{graphName}": { "post": { "tags": [ "Endpoint Device" ], "summary": "Monitoring endpoint to view the selected graph.", "operationId": "post_app_networkobjects_port_http_query_endpointdevice_endpointdevicemonitoring_viewgraph", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "graphName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to generate graph", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewGraphRequest" } } } }, "responses": { "200": { "description": "return graph view in base64", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringGraphResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/{id}/monitored-ports": { "get": { "tags": [ "Endpoint Device" ], "summary": "Endpoint to download all monitored ports for device by id.", "operationId": "get_app_networkobjects_port_http_query_endpointdevice_endpointdevicemonitoring_viewdevicemonitoringports", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Monitored ports", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringDevicesResponse" } } } }, "404": { "description": "Monitored device not found or not registered " }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/mini-list": { "post": { "tags": [ "Endpoint Device" ], "summary": "An endpoint the mini list Endpoint device table.", "operationId": "post_app_networkobjects_port_http_query_endpointdevice_endpointdevicequery_minilist", "requestBody": { "description": "JSON object containing data to search for Endpoint device.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Endpoint device search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/list": { "post": { "tags": [ "Endpoint Device" ], "summary": "An endpoint to search Endpoint device table.", "operationId": "post_app_networkobjects_port_http_query_endpointdevice_endpointdevicequery_list", "requestBody": { "description": "JSON object containing data to search for Endpoint device.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Endpoint device search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListEndpointDeviceResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device-parameter/mini-list": { "post": { "tags": [ "Endpoint Device Parameter" ], "summary": "Endpoint for searching the mini Endpoint Device Parameter list.", "operationId": "post_app_networkobjects_port_http_query_endpointdeviceparameter_endpointdeviceparameterquery_minilist", "requestBody": { "description": "JSON object containing data to search for Mac Addresses.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Endpoint Device Parameter search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceParameterResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-common/{id}/mfa/generate-qr/{type}": { "patch": { "tags": [ "Identity" ], "summary": "An endpoint to generate Google secret QR code", "operationId": "patch_app_networkobjects_port_http_query_identity_identityfilequery_generateqr", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "nacview", "google" ] } } ], "responses": { "404": { "description": "Identity not found by given id" }, "200": { "description": "Single QR image", "content": { "application/png": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-external/{id}/mfa/generate-qr/{type}": { "patch": { "tags": [ "Identity" ], "summary": "An endpoint to generate Google secret QR code", "operationId": "patch_app_networkobjects_port_http_query_identity_identityfilequery_generateqr_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "nacview", "google" ] } } ], "responses": { "404": { "description": "Identity not found by given id" }, "200": { "description": "Single QR image", "content": { "application/png": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity-voucher/{id}/mfa/generate-qr/{type}": { "patch": { "tags": [ "Identity" ], "summary": "An endpoint to generate Google secret QR code", "operationId": "patch_app_networkobjects_port_http_query_identity_identityfilequery_generateqr_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "nacview", "google" ] } } ], "responses": { "404": { "description": "Identity not found by given id" }, "200": { "description": "Single QR image", "content": { "application/png": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/print": { "patch": { "tags": [ "Identity" ], "summary": "endpoint to generate an identity printout.", "operationId": "patch_app_networkobjects_port_http_query_identity_identityprint_print", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityPrintRequest" } } } }, "responses": { "200": { "description": "Single pdf file", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Not found Identity" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/print/bulk": { "patch": { "tags": [ "Identity" ], "summary": "endpoint to generate an identity printout.", "operationId": "patch_app_networkobjects_port_http_query_identity_identityprint_printbulk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityPrintBulkRequest" } } } }, "responses": { "200": { "description": "Single pdf file", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Printable template or Identity not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/get-by-login/{login}": { "get": { "tags": [ "Identity" ], "summary": "An endpoint to retrieve Identity details.", "operationId": "get_app_networkobjects_port_http_query_identity_identityview_viewidentity", "parameters": [ { "name": "login", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Single Identity object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIdentityResponse" } } } }, "404": { "description": "Identity not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/list": { "post": { "tags": [ "Identity" ], "summary": "An endpoint to build and search Identities table.", "operationId": "post_app_networkobjects_port_http_query_identity_listidentityquery_list", "requestBody": { "description": "JSON object containing data to search for Identities.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Identities search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListIdentityResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/mini-list": { "post": { "tags": [ "Identity" ], "summary": "Endpoint for searching the mini Identity list.", "operationId": "post_app_networkobjects_port_http_query_identity_listidentityquery_minilist", "requestBody": { "description": "JSON object containing data to search for Identities.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Identities search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListIdentityResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address/list": { "post": { "tags": [ "Mac Address" ], "summary": "An endpoint to build and search Mac Addresses table.", "operationId": "post_app_networkobjects_port_http_query_macaddress_macaddressquery_list", "requestBody": { "description": "JSON object containing data to search for Mac Addresses.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Mac Addresses search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListMacAddressResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address/mini-list": { "post": { "tags": [ "Mac Address" ], "summary": "Endpoint for searching the mini Mac Address list.", "operationId": "post_app_networkobjects_port_http_query_macaddress_macaddressquery_minilist", "requestBody": { "description": "JSON object containing data to search for Mac Addresses.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Mac Addresses search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMacAddressResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address-vendor/mini-list": { "post": { "tags": [ "Mac Address Vendor" ], "summary": "Endpoint for searching the mini Mac Address Vendor list.", "operationId": "post_app_networkobjects_port_http_query_macaddressvendor_macaddressvendorquery_minilist", "requestBody": { "description": "JSON object containing data to search for Mac Address Vendor.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Mac Address Vendor search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListMacAddressVendorResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } } } } }, "/api/v3/nacview-scout/object-group-config/list": { "post": { "tags": [ "Nacview Scout Object Group Config" ], "summary": "An endpoint to build and search Nacview Scout Object Group Config table.", "operationId": "post_app_networkobjects_port_http_query_nacviewscoutobjectgroupconfig_nacviewscoutobjectgroupconfigquery_list", "requestBody": { "description": "JSON object containing data to search for Nacview Scout Object Group Config.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Nacview Scout Object Group Config search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListNacviewScoutObjectGroupConfigResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/nacview-scout/object-group-config/mini-list": { "post": { "tags": [ "Nacview Scout Object Group Config" ], "summary": "Endpoint for searching the mini Nacview Scout Object Group Config list.", "operationId": "post_app_networkobjects_port_http_query_nacviewscoutobjectgroupconfig_nacviewscoutobjectgroupconfigquery_minilist", "requestBody": { "description": "JSON object containing data to search for Nacview Scout Object Group Config.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Nacview Scout Object Group Config search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListNacviewScoutObjectGroupConfigResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/config/list": { "get": { "tags": [ "Network Device" ], "summary": "An endpoint to list all network-device-configs.", "operationId": "get_network-deviceapp_networkobjects_port_http_query_networkdevice_downloadnetworkdeviceconfig_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Network device object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNetworkDeviceConfigResponse" } } } }, "404": { "description": "Not found Network device." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{networkDeviceId}/config/{networkDeviceConfigUuid}": { "get": { "tags": [ "Network Device" ], "summary": "An endpoint to view network-device-config", "operationId": "get_network-deviceapp_networkobjects_port_http_query_networkdevice_downloadnetworkdeviceconfig_view", "parameters": [ { "name": "networkDeviceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "networkDeviceConfigUuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Single Network device object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNetworkDeviceConfigResponse" } } } }, "404": { "description": "Not found Network device." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{uuid}/batch-commands": { "get": { "tags": [ "Network Device" ], "summary": "Get reports for Network Device", "operationId": "get_network-deviceapp_networkobjects_port_http_query_networkdevice_networkdevicecommandsreport_batchcommands", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reports for Network Device External command", "content": { "application/json": { "schema": { "properties": { "error": { "type": "array", "items": { "properties": { "command": { "type": "string", "example": "show config" }, "error": { "type": "string", "example": "not found command" } }, "type": "object" } }, "success": { "type": "array", "items": { "properties": { "command": { "type": "string", "example": "show version" }, "success": { "type": "string", "example": "4.12.1-lte-r" } }, "type": "object" } } }, "type": "object", "nullable": true } } } }, "202": { "description": "Report is not ready" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/mini-list": { "post": { "tags": [ "Network Device" ], "summary": "An endpoint the mini list Network device table.", "operationId": "post_network-deviceapp_networkobjects_port_http_query_networkdevice_networkdevice_minilist", "requestBody": { "description": "JSON object containing data to search for Network device.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Network device search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/list": { "post": { "tags": [ "Network Device" ], "summary": "An endpoint to search Network device table.", "operationId": "post_network-deviceapp_networkobjects_port_http_query_networkdevice_networkdevice_list", "requestBody": { "description": "JSON object containing data to search for Network device.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Network device search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListNetworkDeviceResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/graph/list": { "get": { "tags": [ "Network Device" ], "summary": "Monitoring endpoint to view list of graphs for selected network device.", "operationId": "get_app_networkobjects_port_http_query_networkdevice_networkdevicemonitoring_listgraphnetworkdevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "return list of graphs", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of network graphs search results.", "type": "array", "items": { "$ref": "#/components/schemas/NetworkDeviceGraphListResponse" } } }, "type": "object" } } } }, "404": { "description": "Network device not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{networkDeviceId}/port/{id}/graph/list": { "get": { "tags": [ "Network Device" ], "summary": "Monitoring endpoint to view list of graphs for selected port.", "operationId": "get_app_networkobjects_port_http_query_networkdevice_networkdevicemonitoring_listgraphport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "networkDeviceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "return list of graphs", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of network graphs search results.", "type": "array", "items": { "$ref": "#/components/schemas/PortGraphListResponse" } } }, "type": "object" } } } }, "404": { "description": "Network device not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/graph/{graphName}": { "post": { "tags": [ "Network Device" ], "summary": "Monitoring endpoint to view the selected graph.", "operationId": "post_app_networkobjects_port_http_query_networkdevice_networkdevicemonitoring_viewgraph", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "graphName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to generate graph", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewGraphRequest" } } } }, "responses": { "200": { "description": "return graph view in base64", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringGraphResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{networkDeviceId}/port/{id}/graph/{graphName}": { "post": { "tags": [ "Network Device" ], "summary": "Monitoring endpoint to view the selected graph.", "operationId": "post_app_networkobjects_port_http_query_networkdevice_networkdevicemonitoring_viewportgraph", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "graphName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "networkDeviceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to generate graph", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewGraphRequest" } } } }, "responses": { "200": { "description": "return graph view in base64", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringGraphResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/monitored-ports": { "get": { "tags": [ "Network Device" ], "summary": "Endpoint to download all monitored ports for device by id.", "operationId": "get_app_networkobjects_port_http_query_networkdevice_networkdevicemonitoring_viewdevicemonitoringports", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Monitored ports", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringDevicesResponse" } } } }, "404": { "description": "Monitored device not found or not registered " }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/profiling-definition/list": { "post": { "tags": [ "Profiling Definition" ], "summary": "An endpoint to build and search Profiling Definition table.", "operationId": "post_app_networkobjects_port_http_query_profilingdefinition_profilingdefinitionquery_list", "requestBody": { "description": "JSON object containing data to search for Profiling Definitions.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Profiling Definition search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListProfilingDefinitionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/profiling-definition/mini-list": { "post": { "tags": [ "Profiling Definition" ], "summary": "Endpoint for searching the mini Profiling Definition list.", "operationId": "post_app_networkobjects_port_http_query_profilingdefinition_profilingdefinitionquery_minilist", "requestBody": { "description": "JSON object containing data to search for Profiling Definitions.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Profiling Definition search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListProfilingDefinitionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/reauth-device-credential/mini-list": { "post": { "tags": [ "Reauth Device Credential" ], "summary": "An endpoint the mini reauth device credential.", "operationId": "post_reauth-device-credentialapp_networkobjects_port_http_query_reauthdevicecredential_reauthdevicecredentialquery_minilist", "requestBody": { "description": "JSON object containing data to search for reauth device credential.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of reauth device credential search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListReauthDeviceCredentialResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/reauth-device-credential/list": { "post": { "tags": [ "Reauth Device Credential" ], "summary": "An endpoint to search reauth device credential table.", "operationId": "post_reauth-device-credentialapp_networkobjects_port_http_query_reauthdevicecredential_reauthdevicecredentialquery_list", "requestBody": { "description": "JSON object containing data to search for reauth device credential.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of reauth device credential search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListReauthDeviceCredentialResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-sms/{configurationPriority}/{serviceType}": { "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator Sms configuration", "operationId": "put_app_notification_port_http_command_creatorsms_creatorsms_update", "parameters": [ { "name": "configurationPriority", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "PRIMARY", "SECONDARY" ] } }, { "name": "serviceType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "SMS_API", "GSM_SERVICE", "SERWER_SMS", "AFILNET", "CLICKATELL", "ASP_SMS", "HOSTED_SMS", "INTELLI_SMS", "VONAGE", "SMS_EAGLE", "NOW_SMS", "SWISSCOM", "OVH_SMS" ] } } ], "requestBody": { "description": "Request to create a Sms configuration", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SmsApiCreatorSmsRequest" }, { "$ref": "#/components/schemas/GsmServiceCreatorSmsRequest" }, { "$ref": "#/components/schemas/SerwerSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/AfilnetCreatorSmsRequest" }, { "$ref": "#/components/schemas/ClickatellCreatorSmsRequest" }, { "$ref": "#/components/schemas/AspSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/HostedSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/IntelliSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/VonageCreatorSmsRequest" }, { "$ref": "#/components/schemas/SmsEagleCreatorSmsRequest" }, { "$ref": "#/components/schemas/NowSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/SwisscomCreatorSmsRequest" }, { "$ref": "#/components/schemas/OvhSmsCreatorSmsRequest" } ] } } } }, "responses": { "204": { "description": "Creator SMS updated" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-smtp": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to view an existing SMTP configuration.", "operationId": "get_app_notification_port_http_query_creatorsmtp_smtpquery_get", "responses": { "404": { "description": "SMTP not found." }, "200": { "description": "Returns the result of the SMTP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSmtpResponse" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update SMTP configuration", "operationId": "put_app_notification_port_http_command_creatorsmtp_creatorsmtpcommand_update", "requestBody": { "description": "Request to update an SMTP Creator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorSmtpRequest" } } } }, "responses": { "201": { "description": "SMTP created successfully" }, "400": { "description": "Incorrect create payload" } } } }, "/api/v3/email/send": { "post": { "tags": [ "CUSTOM NOTIFICATION" ], "summary": "An endpoint to send email", "operationId": "post_app_notification_port_http_command_email_email_sendemail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailRequest" } } } }, "responses": { "400": { "description": "Incorrect testing payload" }, "202": { "description": "A queue has been created to send emails", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/notification-channel": { "post": { "tags": [ "Notification Channel" ], "summary": "An endpoint to create a new Notification Channel.", "operationId": "post_app_notification_port_http_command_notificationchannel_notificationchannelcommand_create", "requestBody": { "description": "JSON object containing data to create a new Notification Channel.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationChannelRequest" } } } }, "responses": { "201": { "description": "Notification Channel has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/notification-channel/{id}": { "get": { "tags": [ "Notification Channel" ], "summary": "An endpoint to view Notification Channel.", "operationId": "get_app_notification_port_http_query_notificationchannel_notificationchannelquery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Notification Channel not found." }, "200": { "description": "Returns the result of the Notification Channel.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNotificationChannelResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Notification Channel" ], "summary": "An endpoint to update an existing Notification Channel.", "operationId": "put_app_notification_port_http_command_notificationchannel_notificationchannelcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to update a Notification Channel.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationChannelRequest" } } } }, "responses": { "204": { "description": "Notification Channel has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Notification Channel has been not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Notification Channel" ], "summary": "An endpoint to delete an existing Notification Channel.", "operationId": "delete_app_notification_port_http_command_notificationchannel_notificationchannelcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Notification Channel has been deleted" }, "404": { "description": "Notification Channel not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/notification-template/{id}": { "get": { "tags": [ "Notification Template" ], "summary": "An endpoint to view notification template.", "operationId": "get_app_notification_port_http_query_notificationtemplate_notificationtemplatequery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Notification Template not found." }, "200": { "description": "Returns the result of the Notification Template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNotificationTemplateResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Notification Template" ], "summary": "An endpoint to update existing notification template.", "operationId": "put_app_notification_port_http_command_notificationtemplate_notificationtemplatecommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update an Notification Template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } } }, "responses": { "201": { "description": "Notification Template created successfully" }, "400": { "description": "Incorrect create payload" } } } }, "/api/v3/sms/send": { "post": { "tags": [ "CUSTOM NOTIFICATION" ], "summary": "An endpoint to send Sms", "operationId": "post_app_notification_port_http_command_sms_sms_sendsms", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSmsRequest" } } } }, "responses": { "202": { "description": "Response from sms api", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSmsResponse" } } } }, "400": { "description": "Incorrect testing payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-sms/{serviceType}/test": { "post": { "tags": [ "System Configuration" ], "summary": "An endpoint to test Creator Sms configuration", "operationId": "post_app_notification_port_http_query_creatorsms_testsms_test", "parameters": [ { "name": "serviceType", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to create a Sms configuration", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SmsApiCreatorSmsRequest" }, { "$ref": "#/components/schemas/GsmServiceCreatorSmsRequest" }, { "$ref": "#/components/schemas/SerwerSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/AfilnetCreatorSmsRequest" }, { "$ref": "#/components/schemas/ClickatellCreatorSmsRequest" }, { "$ref": "#/components/schemas/AspSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/HostedSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/IntelliSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/VonageCreatorSmsRequest" }, { "$ref": "#/components/schemas/SmsEagleCreatorSmsRequest" }, { "$ref": "#/components/schemas/NowSmsCreatorSmsRequest" }, { "$ref": "#/components/schemas/SwisscomCreatorSmsRequest" }, { "$ref": "#/components/schemas/OvhSmsCreatorSmsRequest" } ] } } } }, "responses": { "200": { "description": "Response from sms api" }, "400": { "description": "Incorrect testing payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-sms/{configurationPriority}": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Creator Sms details.", "operationId": "get_app_notification_port_http_query_creatorsms_viewcreatorsms_index", "parameters": [ { "name": "configurationPriority", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "PRIMARY", "SECONDARY" ] } } ], "responses": { "200": { "description": "Returns details of the Creator Sms configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorSmsResponse" } } } }, "500": { "description": "The running Creator Sms configuration not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/notification/{id}": { "get": { "tags": [ "Notification" ], "summary": "An endpoint to view Notification.", "operationId": "get_app_notification_port_http_query_notification_notificationquery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "404": { "description": "Notification not found." }, "200": { "description": "Returns the result of the Notification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewNotificationResponse" } } } } } } }, "/api/v3/notification/list": { "post": { "tags": [ "Notification" ], "summary": "An endpoint to build and search Notification table.", "operationId": "post_app_notification_port_http_query_notification_notificationquery_list", "requestBody": { "description": "JSON object containing data to search for Notification.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Notification search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListNotificationResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" } } } }, "/api/v3/notification-channel/list": { "post": { "tags": [ "Notification Channel" ], "summary": "An endpoint to build and search Notification Channels table.", "operationId": "post_app_notification_port_http_query_notificationchannel_notificationchannelquery_list", "requestBody": { "description": "JSON object containing data to search for Notification Channels.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Notification Channels search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListNotificationChannelResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/notification-channel/mini-list": { "post": { "tags": [ "Notification Channel" ], "summary": "Endpoint for searching the mini Notification Channels list.", "operationId": "post_app_notification_port_http_query_notificationchannel_notificationchannelquery_minilist", "requestBody": { "description": "JSON object containing data to search for Notification Channels.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Notification Channels search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/notification-template/list": { "post": { "tags": [ "Notification Template" ], "summary": "An endpoint to build and search Notification Templates table.", "operationId": "post_app_notification_port_http_query_notificationtemplate_notificationtemplatequery_list", "requestBody": { "description": "JSON object containing data to search for Notification Templates.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Notification Templates search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListNotificationTemplateResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/notification-template/mini-list": { "post": { "tags": [ "Notification Template" ], "summary": "Endpoint for searching the mini Notification Templates list.", "operationId": "post_app_notification_port_http_query_notificationtemplate_notificationtemplatequery_minilist", "requestBody": { "description": "JSON object containing data to search for Notification Templates.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Notification Templates search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationTemplateResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/device-credential": { "post": { "tags": [ "Device Credential" ], "summary": "An endpoint to create a new device credentials.", "operationId": "post_app_organization_port_http_command_devicecredentials_devicecredentialscommand_create", "requestBody": { "description": "JSON object containing data to create a new device credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDeviceCredentialRequest" } } } }, "responses": { "201": { "description": "Device credentials has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/device-credential/{id}": { "get": { "tags": [ "Device Credential" ], "summary": "An endpoint to get an existing device credentials.", "operationId": "get_app_organization_port_http_query_devicecredentials_devicecredentialsquery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the result of the unit data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewDeviceCredentialResponse" } } } }, "404": { "description": "Object not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Device Credential" ], "summary": "An endpoint to update an existing device credentials.", "operationId": "put_app_organization_port_http_command_devicecredentials_devicecredentialscommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to update a Device credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditDeviceCredentialRequest" } } } }, "responses": { "204": { "description": "Device credentials has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Device credentials has been not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Device Credential" ], "summary": "An endpoint to delete an existing Device credentials.", "operationId": "delete_app_organization_port_http_command_devicecredentials_devicecredentialscommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Device credentials has been deleted" }, "404": { "description": "Device credentials not found by given id" }, "409": { "description": "Cannot delete object because it is used in other objects" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/organization-unit": { "post": { "tags": [ "Organization Unit" ], "summary": "An endpoint to create a new organization unit.", "operationId": "post_app_organization_port_http_command_organizationunit_organizationunitcommand_create", "requestBody": { "description": "JSON object containing data to create a new organization unit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOrganizationUnitRequest" } } } }, "responses": { "201": { "description": "Organization unit has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/organization-unit/{id}": { "get": { "tags": [ "Organization Unit" ], "summary": "An endpoint to get an existing organization unit.", "operationId": "get_app_organization_port_http_query_organizationunit_organizationunitquery_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the result of the unit data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewOrganizationUnitResponse" } } } }, "404": { "description": "Organization Unit not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Organization Unit" ], "summary": "An endpoint to update an existing organization unit.", "operationId": "put_app_organization_port_http_command_organizationunit_organizationunitcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to update a Organization unit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditOrganizationUnitRequest" } } } }, "responses": { "204": { "description": "Organization unit has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Organization unit has been not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Organization Unit" ], "summary": "An endpoint to delete an existing Organization Unit.", "operationId": "delete_app_organization_port_http_command_organizationunit_organizationunitcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Organization unit has been deleted" }, "404": { "description": "Organization unit not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/device-credential/list": { "post": { "tags": [ "Device Credential" ], "summary": "An endpoint to build and search device credentials table.", "operationId": "post_app_organization_port_http_query_devicecredentials_devicecredentialsquery_list", "requestBody": { "description": "JSON object containing data to search for Device Credentials.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListDeviceCredentialResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/device-credential/mini-list": { "post": { "tags": [ "Device Credential" ], "summary": "An endpoint to build and search device credentials table.", "operationId": "post_app_organization_port_http_query_devicecredentials_devicecredentialsquery_minilist", "requestBody": { "description": "JSON object containing data to search for Device Credentials.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/organization-unit/list": { "post": { "tags": [ "Organization Unit" ], "summary": "An endpoint to build and search organization unit table.", "operationId": "post_app_organization_port_http_query_organizationunit_organizationunitquery_list", "requestBody": { "description": "JSON object containing data to search for Organization Unit.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListOrganizationUnitResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/organization-unit/mini-list": { "post": { "tags": [ "Organization Unit" ], "summary": "An endpoint to build and search organization unit table.", "operationId": "post_app_organization_port_http_query_organizationunit_organizationunitquery_minilist", "requestBody": { "description": "JSON object containing data to search for Organization Unit.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "type": "integer", "example": 5 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/event-definition": { "post": { "tags": [ "Event Definition" ], "summary": "An endpoint to create a new Event Definition.", "operationId": "post_app_queue_port_http_command_eventdefinition_eventdefinition_create", "requestBody": { "description": "JSON object containing data to create a new Event Definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventDefinitionRequest" } } } }, "responses": { "201": { "description": "Event Definition has been created" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/event-definition/{id}": { "get": { "tags": [ "Event Definition" ], "summary": "An endpoint to view Event definition.", "operationId": "get_app_queue_port_http_query_eventdefinitionquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Event definition object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewEventDefinitionResponse" } } } }, "404": { "description": "Not found Event definition." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Event Definition" ], "summary": "An endpoint to update an existing Event Definition.", "operationId": "put_app_queue_port_http_command_eventdefinition_eventdefinition_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "JSON object containing data to update a Event Definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOrganizationUnitRequest" } } } }, "responses": { "204": { "description": "Event Definition has been updated" }, "400": { "description": "Bad request" }, "404": { "description": "Event Definition has been not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Event Definition" ], "summary": "An endpoint to delete an existing Event Definition.", "operationId": "delete_app_queue_port_http_command_eventdefinition_eventdefinition_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Event Definition has been deleted" }, "404": { "description": "Event Definition not found by given id" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/queue/rebuild-config": { "patch": { "tags": [ "Queue" ], "summary": "This endpoint can run new config queue", "operationId": "patch_app_queue_port_http_command_queuerebuildconfiguration_initqueue", "requestBody": { "description": "Request to change activity for job queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueRebuildConfiguration" } } } }, "responses": { "201": { "description": "Run new config queue", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/queue/{id}": { "get": { "tags": [ "Queue" ], "summary": "The endpoint list all queues jobs.", "operationId": "get_app_queue_port_http_query_listqueue_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single job of queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewQueueResponse" } } } }, "404": { "description": "Not found any jobs" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Queue" ], "summary": "This endpoint can remove job from one queue", "operationId": "delete_app_queue_port_http_command_removingqueuefromjobqueue_removingjob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Job queue has been removed" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/queue": { "delete": { "tags": [ "Queue" ], "summary": "This endpoint can remove jobs from all queue", "operationId": "delete_app_queue_port_http_command_removingqueuefromjobqueue_removingjobs", "responses": { "204": { "description": "All jobs queue has been removed" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/queue/activity/{id}": { "put": { "tags": [ "Queue" ], "summary": "This endpoint can enable and disable a given queue", "operationId": "put_app_queue_port_http_command_updatejobqueue_changeactivity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to change activity for job queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeActivityJobQueueRequest" } } } }, "responses": { "204": { "description": "Queue status changed correctly" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/queue/interval/{id}": { "put": { "tags": [ "Queue" ], "summary": "This endpoint can change the interval time for the job queue to run", "operationId": "put_app_queue_port_http_command_updatejobqueue_intervaltime", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to change activity for job queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeIntervalJobQueueRequest" } } } }, "responses": { "204": { "description": "Queue interval changed correctly" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/event-definition/mini-list": { "post": { "tags": [ "Event Definition" ], "summary": "An endpoint the mini list Event definition table.", "operationId": "post_app_queue_port_http_query_eventdefinitionquery_minilist", "requestBody": { "description": "JSON object containing data to search for Event definition.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Event definition search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListEventDefinitionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/event-definition/list": { "post": { "tags": [ "Event Definition" ], "summary": "An endpoint to search Event definition table.", "operationId": "post_app_queue_port_http_query_eventdefinitionquery_list", "requestBody": { "description": "JSON object containing data to search for Event definition.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Event definition search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListEventDefinitionResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/event-definition/{id}/logs": { "get": { "tags": [ "Event Definition" ], "summary": "An endpoint to view log of event definition from last 24h.", "operationId": "get_app_queue_port_http_query_eventdefinitionquery_viewlog", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Event definition search results.", "type": "array", "items": { "$ref": "#/components/schemas/LogEventDefinitionResponse" } } }, "type": "object" } } } }, "404": { "description": "Event Definition not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/queue/list": { "post": { "tags": [ "Queue" ], "summary": "The endpoint list all queues jobs.", "operationId": "post_app_queue_port_http_query_listqueue_list", "requestBody": { "description": "JSON object containing data to search for Network device.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Network device search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/queue/status/{jobName}": { "get": { "tags": [ "Queue" ], "summary": "The endpoint to view details of queues jobs.", "operationId": "get_app_queue_port_http_query_listqueue_viewstatus", "parameters": [ { "name": "jobName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The current state of the entire queue", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "redisReceivedStamp": { "type": "string", "example": "1687263579627-0" }, "createdAt": { "type": "string", "example": "2023-06-20 14:19:40" }, "finishedAt": { "type": "string", "example": "2023-06-20 14:19:40", "nullable": true }, "status": { "description": "0 - 'PENDING', 2 - 'CREATED', 3 - 'EXCEPTION', 4 - 'BLOCKED'", "type": "integer", "example": 1 }, "jobName": { "type": "string", "example": "Mailing" }, "exception": { "type": "string", "example": "failed: Not found object error", "nullable": true }, "triggeredBy": { "type": "string", "example": "admin@nacview.com", "nullable": true } }, "type": "object" } } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-syslog": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Creator Syslog details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_creatorsyslog_creatorsyslogquery_view", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View Creator Syslog object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorSyslogResponse" } } } }, "404": { "description": "CreatorSyslog not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator Syslog", "operationId": "put_app_searchdatainfrastructure_port_http_command_creatorsyslog_creatorsyslogcommand_update", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to update an Creator Syslog", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorSyslogRequest" } } } }, "responses": { "204": { "description": "Creator Syslog updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-dhcp/release": { "patch": { "tags": [ "Events" ], "summary": "An endpoint to remove lease.", "operationId": "patch_app_searchdatainfrastructure_port_http_command_events_eventscommand_removelease", "requestBody": { "description": "Request to remove lease for given Ip address and MAC address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveLeaseSubnetworkRequest" } } } }, "responses": { "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/indexes/reload": { "patch": { "tags": [ "Indexes" ], "summary": "An endpoint to reload an indexes", "operationId": "patch_app_searchdatainfrastructure_port_http_command_index_indexescommand_reload", "responses": { "201": { "description": "Indexes has been reloaded" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/indexes/{id}/change-status": { "put": { "tags": [ "Indexes" ], "summary": "An endpoint to change status of index", "operationId": "put_app_searchdatainfrastructure_port_http_command_index_indexescommand_changestatus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Indexes status has been changed" }, "404": { "description": "Index not found" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/indexes/{id}": { "get": { "tags": [ "Indexes" ], "summary": "An endpoint to retrieve Indexes details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_index_indexesquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Single Indexes object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewIndexesResponse" } } } }, "404": { "description": "Indexes not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Indexes" ], "summary": "An endpoint to delete index", "operationId": "delete_app_searchdatainfrastructure_port_http_command_index_indexescommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Index has been deleted" }, "404": { "description": "Index not found" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/log-rotation-configuration": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Log Rotation Configuration details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_logrotationconfiguration_logrotationconfigurationquery_view", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View Log Rotation Configuration object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewLogRotationConfigurationResponse" } } } }, "404": { "description": "LogRotationConfiguration not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Log Rotation Configuration", "operationId": "put_app_searchdatainfrastructure_port_http_command_logrotationconfiguration_logrotationconfigurationcommand_update", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to update an Log Rotation Configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogRotationConfigurationRequest" } } } }, "responses": { "204": { "description": "Log Rotation Configuration updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-tacacs/histogram/{intervalType}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve authorize events aggregated in histogram.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_dashboardeventshistogram_histogram", "parameters": [ { "name": "intervalType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "hour", "day", "month" ] } } ], "responses": { "404": { "description": "Not found log type by given route" }, "200": { "description": "Returns the result data for histogram", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of buckets", "type": "integer" }, "data": { "description": "An array of aggregated events", "type": "array", "items": { "$ref": "#/components/schemas/AuthEventAggregatedResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-authorize/histogram/{intervalType}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve authorize events aggregated in histogram.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_dashboardeventshistogram_histogram_1", "parameters": [ { "name": "intervalType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "hour", "day", "month" ] } } ], "responses": { "404": { "description": "Not found log type by given route" }, "200": { "description": "Returns the result data for histogram", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of buckets", "type": "integer" }, "data": { "description": "An array of aggregated events", "type": "array", "items": { "$ref": "#/components/schemas/AuthEventAggregatedResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-otp/histogram/{intervalType}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve authorize events aggregated in histogram.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_dashboardeventshistogram_histogram_2", "parameters": [ { "name": "intervalType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "hour", "day", "month" ] } } ], "responses": { "404": { "description": "Not found log type by given route" }, "200": { "description": "Returns the result data for histogram", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of buckets", "type": "integer" }, "data": { "description": "An array of aggregated events", "type": "array", "items": { "$ref": "#/components/schemas/AuthEventAggregatedResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-authorize/policy-histogram/{intervalType}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve authorize events aggregated in histogram.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_dashboardeventshistogram_histogrampolicy", "parameters": [ { "name": "intervalType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "hour", "day", "month" ] } } ], "responses": { "404": { "description": "Not found log type by given route" }, "200": { "description": "Returns the result data for histogram", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of buckets", "type": "integer" }, "data": { "description": "An array of aggregated events", "type": "array", "items": { "$ref": "#/components/schemas/AuthEventsCategoryAggregationResponse" } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-authorize/policy-histogram/list": { "post": { "tags": [ "Events" ], "summary": "An endpoint to search events of matrix policy category.", "operationId": "post_app_searchdatainfrastructure_port_http_query_events_dashboardeventshistogram_listhistogrampolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListHistogramPolicyRequest" } } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of events search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListDashboardMatrixPolicyResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/{id}/events-{type}/list": { "post": { "tags": [ "Endpoint Device" ], "operationId": "post_app_endpoint_device_events_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|dhcp|msevents|syslog", "enum": [ "accounting", "authorize", "dhcp", "msevents", "syslog" ] } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Events search results.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ListEventsSyslogResponse" }, { "$ref": "#/components/schemas/ListEventsMseventsResponse" }, { "$ref": "#/components/schemas/ListEventsDhcpResponse" }, { "$ref": "#/components/schemas/ListEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ListEventsAccountingResponse" } ] } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/endpoint-device/{id}/events-{type}/{uid}": { "get": { "tags": [ "Endpoint Device" ], "operationId": "get_app_endpoint_device_events_view", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|dhcp|msevents|syslog", "enum": [ "accounting", "authorize", "dhcp", "msevents", "syslog" ] } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-{type}/list": { "post": { "tags": [ "Events" ], "summary": "An endpoint to build and search data from index.", "operationId": "post_app_events_list", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "syslog|accounting|authorize|otp|tacacs|dhcp|msevents|snmptrap", "enum": [ "syslog", "accounting", "authorize", "otp", "tacacs", "dhcp", "msevents", "snmptrap" ] } } ], "requestBody": { "description": "JSON object containing data to search for index data.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Events search results.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ListEventsTacacsResponse" }, { "$ref": "#/components/schemas/ListEventsSyslogResponse" }, { "$ref": "#/components/schemas/ListEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ListEventsOtpResponse" }, { "$ref": "#/components/schemas/ListEventsMseventsResponse" }, { "$ref": "#/components/schemas/ListEventsDhcpResponse" }, { "$ref": "#/components/schemas/ListEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ListEventsAccountingResponse" } ] } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-syslog/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-accounting/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view_1", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-authorize/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view_2", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-otp/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view_3", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-tacacs/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view_4", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-dhcp/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view_5", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-msevents/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view_6", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/events-snmptrap/{uid}": { "get": { "tags": [ "Events" ], "summary": "An endpoint to retrieve index data details.", "operationId": "get_app_searchdatainfrastructure_port_http_query_events_eventsquery_view_7", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/{id}/events-{type}/list": { "post": { "tags": [ "Identity" ], "operationId": "post_app_identity_events_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|otp|msevents", "enum": [ "accounting", "authorize", "otp", "msevents" ] } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Events search results.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ListEventsAccountingResponse" }, { "$ref": "#/components/schemas/ListEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ListEventsOtpResponse" }, { "$ref": "#/components/schemas/ListEventsMseventsResponse" } ] } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/identity/{id}/events-{type}/{uid}": { "get": { "tags": [ "Identity" ], "operationId": "get_app_identity_events_view", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|otp|msevents", "enum": [ "accounting", "authorize", "otp", "msevents" ] } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsAccountingResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsMseventsResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ip-address/{id}/events-{type}/list": { "post": { "tags": [ "Ip Address" ], "operationId": "post_app_ip_address_events_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "dhcp" } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Events search results.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ListEventsDhcpResponse" } ] } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/ip-address/{id}/events-{type}/{uid}": { "get": { "tags": [ "Ip Address" ], "operationId": "get_app_ip_address_events_view", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "dhcp" } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewEventsDhcpResponse" } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address/{id}/events-{type}/list": { "post": { "tags": [ "Mac Address" ], "operationId": "post_app_mac_address_events_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|dhcp", "enum": [ "accounting", "authorize", "dhcp" ] } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Events search results.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ListEventsAccountingResponse" }, { "$ref": "#/components/schemas/ListEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ListEventsDhcpResponse" } ] } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/mac-address/{id}/events-{type}/{uid}": { "get": { "tags": [ "Mac Address" ], "operationId": "get_app_mac_address_events_view", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|dhcp", "enum": [ "accounting", "authorize", "dhcp" ] } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsAccountingResponse" }, { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsDhcpResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/events-{type}/list": { "post": { "tags": [ "Network Device" ], "operationId": "post_app_network_device_events_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|otp|syslog|snmptrap|tacacs", "enum": [ "accounting", "authorize", "otp", "syslog", "snmptrap", "tacacs" ] } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Events search results.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ListEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ListEventsAccountingResponse" }, { "$ref": "#/components/schemas/ListEventsTacacsResponse" }, { "$ref": "#/components/schemas/ListEventsOtpResponse" }, { "$ref": "#/components/schemas/ListEventsSyslogResponse" }, { "$ref": "#/components/schemas/ListEventsSnmptrapResponse" } ] } } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/network-device/{id}/events-{type}/{uid}": { "get": { "tags": [ "Network Device" ], "operationId": "get_app_network_device_events_view", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "accounting|authorize|otp|syslog|snmptrap|tacacs", "enum": [ "accounting", "authorize", "otp", "syslog", "snmptrap", "tacacs" ] } } ], "responses": { "200": { "description": "Returns single event data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ViewEventsAuthorizeResponse" }, { "$ref": "#/components/schemas/ViewEventsAccountingResponse" }, { "$ref": "#/components/schemas/ViewEventsTacacsResponse" }, { "$ref": "#/components/schemas/ViewEventsOtpResponse" }, { "$ref": "#/components/schemas/ViewEventsSyslogResponse" }, { "$ref": "#/components/schemas/ViewEventsSnmptrapResponse" } ] } } } }, "404": { "description": "Not found event data" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/{id}/events-{type}/list": { "post": { "tags": [ "User" ], "operationId": "post_app_searchdatainfrastructure_port_http_query_events_usereventsquery_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "tacacs" } } ], "responses": { "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/user/{id}/events-{type}/{uid}": { "get": { "tags": [ "User" ], "operationId": "get_app_searchdatainfrastructure_port_http_query_events_usereventsquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "pattern": "tacacs" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/indexes/list": { "post": { "tags": [ "Indexes" ], "summary": "An endpoint to build and search index table.", "operationId": "post_app_searchdatainfrastructure_port_http_query_index_indexesquery_list", "requestBody": { "description": "JSON object containing data to search for Indexes.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of Indexes search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListIndexesResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-backup": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Creator Backup details.", "operationId": "get_app_systembackup_port_http_query_creatorbackup_creatorbackupquery_view", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View Creator Backup object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorBackupResponse" } } } }, "404": { "description": "Creator Backup not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator Backup", "operationId": "put_app_systembackup_port_http_command_creatorbackup_creatorbackupcommand_update", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to update an Creator Backup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorBackupRequest" } } } }, "responses": { "204": { "description": "Creator Backup updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/config/creator-disaster-recovery": { "get": { "tags": [ "System Configuration" ], "summary": "An endpoint to retrieve Creator Disaster Recovery details.", "operationId": "get_app_systembackup_port_http_query_creatordisasterrecovery_creatordisasterrecoveryquery_view", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View Creator Disaster Recovery object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreatorDisasterRecoveryResponse" } } } }, "404": { "description": "Creator Disaster Recovery not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Configuration" ], "summary": "An endpoint to update Creator DisasterRecovery", "operationId": "put_app_systembackup_port_http_command_creatordisasterrecovery_creatordisasterrecoverycommand_update", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to update an Creator DisasterRecovery", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatorDisasterRecoveryRequest" } } } }, "responses": { "204": { "description": "Creator DisasterRecovery updated successfully" }, "400": { "description": "Incorrect update payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license/upload": { "post": { "tags": [ "System License" ], "summary": "Upload and apply an encrypted license.", "operationId": "post_app_systemcondition_port_http_command_systemlicense_systemlicense_upload", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "license" ], "properties": { "license": { "description": "Encrypted license file to preview", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "204": { "description": "License uploaded successfully" }, "400": { "description": "Invalid or missing file.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license/request": { "post": { "tags": [ "System License" ], "summary": "An endpoint to create request for new license", "operationId": "post_app_systemcondition_port_http_command_systemlicense_systemlicenserequest_create", "requestBody": { "description": "Request to create a new System License", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemLicenseRequestRequest" } } } }, "responses": { "201": { "description": "System License Request created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node": { "post": { "tags": [ "System Node" ], "summary": "An endpoint to create new System Node", "operationId": "post_app_systemcondition_port_http_command_systemnode_systemnode_create", "requestBody": { "description": "Request to create a new System Node", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSystemNodeRequest" } } } }, "responses": { "201": { "description": "System Node created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{id}": { "get": { "tags": [ "System Node" ], "summary": "The endpoint get System node.", "operationId": "get_app_systemcondition_port_http_query_systemnodequery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the view result for System node", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSystemNodeResponse" } } } }, "404": { "description": "Not found System node" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Node" ], "summary": "An endpoint to update existing System Node", "operationId": "put_app_systemcondition_port_http_command_systemnode_systemnode_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a existing System Node", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditSystemNodeRequest" } } } }, "responses": { "201": { "description": "System Node has been updated successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "System Node" ], "summary": "An endpoint to delete an existing System Node", "operationId": "delete_app_systemcondition_port_http_command_systemnode_systemnode_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "System Node has been successfully removed" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{id}/confirm": { "patch": { "tags": [ "System Node" ], "summary": "An endpoint to confirm a System Node", "operationId": "patch_app_systemcondition_port_http_command_systemnode_systemnode_confirm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "System Node has been confirmed successfully" }, "400": { "description": "Incorrect request payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/refresh-configuration": { "patch": { "tags": [ "System Node" ], "summary": "An endpoint to refresh configuration of selected system nodes", "operationId": "patch_app_systemcondition_port_http_command_systemnode_systemnode_refreshconfiguration", "requestBody": { "description": "Request to refresh configuration of selected system nodes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshConfigurationSystemNodeRequest" } } } }, "responses": { "201": { "description": "System Nodes refreshed successfully", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/replication": { "patch": { "tags": [ "System Node" ], "summary": "An endpoint to replication db for selected nodes", "operationId": "patch_app_systemcondition_port_http_command_systemnode_systemnode_replication", "requestBody": { "description": "Request to replicate db for a existing System Nodes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplicationSystemNodeDbRequest" } } } }, "responses": { "201": { "description": "Db replicated successfully for selected system nodes", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{id}/archive-migrator": { "patch": { "tags": [ "System Node" ], "summary": "Enqueues archive migration for selected system node", "operationId": "patch_app_systemcondition_port_http_command_systemnode_systemnode_enqueuearchivemigration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Archive migration enqueued", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "409": { "description": "Archive migration already running", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "format": "string", "example": "Archive migration is already running" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/confirm/upgrade": { "patch": { "tags": [ "System Node" ], "summary": "endpoint where you can confirm if an update is available for your current license", "operationId": "patch_app_systemcondition_port_http_command_systemnode_systemnodeupgrade_confirmupdate", "responses": { "202": { "description": "Details of your license gives you access to upgrade", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmUpgradeResponse" } } } }, "204": { "description": "Your version is already up to date" }, "400": { "description": "Invalid request. For more details, see the error response" }, "406": { "description": "You do not have permission to update" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/master/upgrade": { "patch": { "tags": [ "System Node" ], "summary": "An endpoint to master upgrade", "operationId": "patch_app_systemcondition_port_http_command_systemnode_systemnodeupgrade_masterupgrade", "responses": { "201": { "description": "Init updating master system node", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "423": { "description": "You do not have permission to update" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/slave/upgrade": { "patch": { "tags": [ "System Node" ], "summary": "An endpoint to slave upgrade by id", "operationId": "patch_app_systemcondition_port_http_command_systemnode_systemnodeupgrade_slaveupgrade", "requestBody": { "description": "System node upgrade", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeSlaveSystemNode" } } } }, "responses": { "201": { "description": "Init updating slave system node", "content": { "application/json": { "schema": { "properties": { "uuid": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" } } } }, "400": { "description": "Invalid system node ID" }, "409": { "description": "The master version is the current version, as is the slave version" }, "423": { "description": "You do not have permission to update" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-firewall": { "post": { "tags": [ "System Node Firewall" ], "summary": "An endpoint to create new System Node Firewall", "operationId": "post_app_systemcondition_port_http_command_systemnodefirewall_systemnodefirewall_create", "requestBody": { "description": "Request to create a new System Node Firewall", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemNodeFirewallRequest" } } } }, "responses": { "201": { "description": "System Node Firewall created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-firewall/{id}": { "get": { "tags": [ "System Node Firewall" ], "summary": "The endpoint get System node firewall.", "operationId": "get_app_systemcondition_port_http_query_systemnodefirewallquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the view result for System node firewall", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSystemNodeFirewallResponse" } } } }, "404": { "description": "Not found System node firewall" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Node Firewall" ], "summary": "An endpoint to update existing System Node Firewall", "operationId": "put_app_systemcondition_port_http_command_systemnodefirewall_systemnodefirewall_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a existing System Node Firewall", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemNodeFirewallRequest" } } } }, "responses": { "201": { "description": "System Node Firewall has been updated successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "System Node Firewall" ], "summary": "An endpoint to delete System Node Firewall", "operationId": "delete_app_systemcondition_port_http_command_systemnodefirewall_systemnodefirewall_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "System Node Firewall has been successfully removed" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{systemNodeId}/system-node-interface": { "post": { "tags": [ "System Node Interface" ], "summary": "An endpoint to create new System Node Interface", "operationId": "post_app_systemcondition_port_http_command_systemnodeinterface_systemnodeinterfacecommand_create", "parameters": [ { "name": "systemNodeId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "Request to create a new System Node Interface", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemNodeInterfaceRequest" } } } }, "responses": { "201": { "description": "System Node Interface created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{systemNodeId}/system-node-interface/{id}": { "get": { "tags": [ "System Node Interface" ], "summary": "The endpoint get System node interface.", "operationId": "get_app_systemcondition_port_http_query_systemnodeinterfacequery_view", "parameters": [ { "name": "systemNodeId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the view result for System node interface", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSystemNodeInterfaceResponse" } } } }, "404": { "description": "Not found System node interface" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Node Interface" ], "summary": "An endpoint to update existing System Node Interface", "operationId": "put_app_systemcondition_port_http_command_systemnodeinterface_systemnodeinterfacecommand_update", "parameters": [ { "name": "systemNodeId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a existing System Node Interface", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemNodeInterfaceRequest" } } } }, "responses": { "201": { "description": "System Node Interface has been updated successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "System Node Interface" ], "summary": "An endpoint to delete System Node Interface Interface", "operationId": "delete_app_systemcondition_port_http_command_systemnodeinterface_systemnodeinterfacecommand_delete", "parameters": [ { "name": "systemNodeId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "System Node Interface Interface has been successfully removed" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-routing": { "post": { "tags": [ "System Node Routing" ], "summary": "An endpoint to create new System Node Routing", "operationId": "post_app_systemcondition_port_http_command_systemnoderouting_systemnoderoutingcommand_create", "requestBody": { "description": "Request to create a new System Node Routing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemNodeRoutingRequest" } } } }, "responses": { "201": { "description": "System Node Routing created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-routing/{id}": { "get": { "tags": [ "System Node Routing" ], "summary": "The endpoint get System node routing.", "operationId": "get_app_systemcondition_port_http_query_systemnoderoutingquery_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the view result for System node routing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSystemNodeRoutingResponse" } } } }, "404": { "description": "System node routing not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "System Node Routing" ], "summary": "An endpoint to update existing System Node Routing", "operationId": "put_app_systemcondition_port_http_command_systemnoderouting_systemnoderoutingcommand_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a existing System Node Routing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemNodeRoutingRequest" } } } }, "responses": { "201": { "description": "System Node Routing has been updated successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "System Node Routing" ], "summary": "An endpoint to delete System Node Routing Routing", "operationId": "delete_app_systemcondition_port_http_command_systemnoderouting_systemnoderoutingcommand_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "201": { "description": "System Node Routing Routing has been successfully removed" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-status/{id}": { "post": { "tags": [ "System Node Status" ], "summary": "An endpoint to generate System node status only for one", "operationId": "post_app_systemcondition_port_http_command_systemnodestatus_systemnodestatuscommand_create", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "201": { "description": "System Node Interface created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-status": { "get": { "tags": [ "System Node Status" ], "summary": "The endpoint get System node status.", "operationId": "get_app_systemcondition_port_http_query_systemnodestatusquery_view", "responses": { "200": { "description": "Returns the view result for System node status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemNodeStatusResponse" } } } }, "404": { "description": "Not found System node status" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "post": { "tags": [ "System Node Status" ], "summary": "An endpoint to generate System node status for all nodes", "operationId": "post_app_systemcondition_port_http_command_systemnodestatus_systemnodestatuscommand_createall", "parameters": [ { "name": "systemNodeId", "in": "path", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "System Node Status created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vrrp-system-node": { "post": { "tags": [ "Vrrp System Node" ], "summary": "An endpoint to create new Vrrp System Node", "operationId": "post_app_systemcondition_port_http_command_vrrpsystemnode_vrrpsystemnode_create", "requestBody": { "description": "Request to create a new Vrrp System Node", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VrrpSystemNodeRequest" } } } }, "responses": { "201": { "description": "Vrrp System Node was updated successfully" }, "400": { "description": "Invalid request payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vrrp-system-node/{id}": { "get": { "tags": [ "Vrrp System Node" ], "summary": "Retrieves a Vrrp System Node by its ID.", "operationId": "get_app_systemcondition_port_http_query_vrrpsystemnode_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the Vrrp System Node details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewVrrpSystemNodeResponse" } } } }, "404": { "description": "Vrrp System Node with the given ID was not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "put": { "tags": [ "Vrrp System Node" ], "summary": "An endpoint to assign existing Vrrp System Node to System Node", "operationId": "put_app_systemcondition_port_http_command_vrrpsystemnode_vrrpsystemnode_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to update a existing Vrrp System Node", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VrrpSystemNodeRequest" } } } }, "responses": { "201": { "description": "Vrrp System Node was updated successfully" }, "400": { "description": "Invalid request payload" }, "404": { "description": "Vrrp System Node with the given ID was not found" }, "409": { "description": "The System Node is already assigned to a different Vrrp System Node" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Vrrp System Node" ], "summary": "An endpoint to delete an existing Vrrp System Node", "operationId": "delete_app_systemcondition_port_http_command_vrrpsystemnode_vrrpsystemnode_delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "201": { "description": "Vrrp System Node was updated successfully" }, "404": { "description": "Vrrp System Node with the given ID was not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license": { "get": { "tags": [ "System License" ], "summary": "An endpoint to retrieve System License details.", "operationId": "get_app_systemcondition_port_http_query_systemlicensequery_view", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "View System License object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSystemLicenseResponse" } } } }, "404": { "description": "System License not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license/hourly": { "get": { "tags": [ "System License" ], "summary": "An endpoint to retrieve System License hourly usage from last 7 days.", "operationId": "get_app_systemcondition_port_http_query_systemlicensequery_gethourlylicenseusage", "responses": { "200": { "description": "Last days usage found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HourlyLicenseUsageResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license/daily": { "get": { "tags": [ "System License" ], "summary": "An endpoint to retrieve System License daily usage from last 5 months.", "operationId": "get_app_systemcondition_port_http_query_systemlicensequery_getdailylicenseusage", "responses": { "200": { "description": "Last months usage found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DailyLicenseUsageResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license/monthly": { "get": { "tags": [ "System License" ], "summary": "An endpoint to retrieve System License monthly usage from last 5 months.", "operationId": "get_app_systemcondition_port_http_query_systemlicensequery_getmonthlylicenseusage", "responses": { "200": { "description": "Last months usage found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyLicenseSummaryResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license/preview": { "post": { "tags": [ "System License" ], "summary": "Upload an encrypted license and preview its decrypted contents (CQRS Query).", "operationId": "post_app_systemcondition_port_http_query_systemlicensequery_previewencryptedlicense", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "license" ], "properties": { "license": { "description": "Encrypted license file to preview", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Decrypted license preview.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewEncryptedLicenseResponse" } } } }, "400": { "description": "Invalid or missing file.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-license/request/{uuid}/download": { "get": { "tags": [ "System License" ], "summary": "Download previously generated System License Request XML by UUID.", "operationId": "get_app_systemcondition_port_http_query_systemlicenserequestfilequery_download", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns the XML file as an attachment" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-firewall/list": { "post": { "tags": [ "System Node Firewall" ], "summary": "The endpoint list data of System Node Firewall.", "operationId": "post_app_systemcondition_port_http_query_systemnodefirewallquery_list", "requestBody": { "description": "JSON object containing data to search for System Node Firewall.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node Firewall search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListSystemNodeFirewallResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-firewall/mini-list": { "post": { "tags": [ "System Node Firewall" ], "summary": "The endpoint mini-list data of System Node Firewall.", "operationId": "post_app_systemcondition_port_http_query_systemnodefirewallquery_minilist", "requestBody": { "description": "JSON object containing data to search for System Node Firewall.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node Firewall search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeFirewallResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{systemNodeId}/system-node-interface/list": { "post": { "tags": [ "System Node Interface" ], "summary": "The endpoint list data of System Node Interface.", "operationId": "post_app_systemcondition_port_http_query_systemnodeinterfacequery_list", "parameters": [ { "name": "systemNodeId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node Interface search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListSystemNodeInterfaceResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{systemNodeId}/system-node-interface/mini-list": { "post": { "tags": [ "System Node Interface" ], "summary": "The endpoint mini-list data of System Node Interface.", "operationId": "post_app_systemcondition_port_http_query_systemnodeinterfacequery_minilist", "parameters": [ { "name": "systemNodeId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node Interface search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{id}/graph/list": { "get": { "tags": [ "System Node" ], "summary": "Monitoring endpoint to view list of graphs for selected system node.", "operationId": "get_app_systemcondition_port_http_query_systemnodemonitoring_listgraphsystemnode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "return list of graphs", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of system node graphs search results.", "type": "array", "items": { "$ref": "#/components/schemas/SystemNodeGraphListResponse" } } }, "type": "object" } } } }, "404": { "description": "System node not found" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{id}/graph/{graphName}": { "post": { "tags": [ "System Node" ], "summary": "Monitoring endpoint to view the selected graph.", "operationId": "post_app_systemcondition_port_http_query_systemnodemonitoring_viewgraph", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "graphName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to generate graph", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewGraphRequest" } } } }, "responses": { "200": { "description": "return graph view in base64", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringGraphResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{id}/monitored-ports": { "get": { "tags": [ "System Node" ], "summary": "Endpoint to download all monitored ports for device by id.", "operationId": "get_app_systemcondition_port_http_query_systemnodemonitoring_viewdevicemonitoringports", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Monitored ports", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringDevicesResponse" } } } }, "404": { "description": "Monitored device not found or not registered " }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for user with appropriate permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/list": { "post": { "tags": [ "System Node" ], "summary": "The endpoint list data of System Node.", "operationId": "post_app_systemcondition_port_http_query_systemnodequery_list", "requestBody": { "description": "JSON object containing data to search for System Node.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListSystemNodeResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/mini-list": { "post": { "tags": [ "System Node" ], "summary": "The endpoint mini-list data of System Node.", "operationId": "post_app_systemcondition_port_http_query_systemnodequery_minilist", "requestBody": { "description": "JSON object containing data to search for System Node.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node/{id}/configuration": { "patch": { "tags": [ "System Node" ], "summary": "An endpoint to fetch configuration for existing System Node", "operationId": "patch_app_systemcondition_port_http_query_systemnodequery_fetchconfiguration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "description": "Request to prepare and return configuration file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationSystemNodeRequest" } } } }, "responses": { "200": { "description": "System Node configuration as json" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-routing/list": { "post": { "tags": [ "System Node Routing" ], "summary": "The endpoint list data of System Node Routing.", "operationId": "post_app_systemcondition_port_http_query_systemnoderoutingquery_list", "requestBody": { "description": "JSON object containing data to search for System Node Routing.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node Routing search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListSystemNodeRoutingResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-routing/mini-list": { "post": { "tags": [ "System Node Routing" ], "summary": "The endpoint mini-list data of System Node Routing.", "operationId": "post_app_systemcondition_port_http_query_systemnoderoutingquery_minilist", "requestBody": { "description": "JSON object containing data to search for System Node Routing.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns the result of the search query.", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node Routing search results.", "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeRoutingResponse" } } }, "type": "object" } } } }, "400": { "description": "Incorrect search payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/system-node-status/basic": { "get": { "tags": [ "System Node Status" ], "summary": "The endpoint get only count of errors and warnings for System node status.", "operationId": "get_app_systemcondition_port_http_query_systemnodestatusquery_viewinfostatus", "responses": { "200": { "description": "Returns the view result for System node status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountInfoOfSystemNodeStatusResponse" } } } }, "404": { "description": "Not found System node status" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vrrp-system-node/list": { "post": { "tags": [ "Vrrp System Node" ], "summary": "Retrieves a list of Vrrp System Nodes based on search criteria.", "operationId": "post_app_systemcondition_port_http_query_vrrpsystemnode_list", "requestBody": { "description": "JSON object containing data to search for Vrrp System Node.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns a list of Vrrp System Nodes matching the search criteria", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListVrrpSystemNodeResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid request payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/vrrp-system-node/mini-list": { "post": { "tags": [ "Vrrp System Node" ], "summary": "Retrieves a list of Vrrp System Nodes based on search criteria.", "operationId": "post_app_systemcondition_port_http_query_vrrpsystemnode_minilist", "requestBody": { "description": "JSON object containing data to search for Vrrp System Node.", "content": { "application/json": { "schema": { "type": "object" }, "example": "{\"state\":{\"filter\":{\"filters\":[{\"filters\":[{\"field\":\"name\",\"operator\":\"contains\",\"value\":\"test\"}],\"logic\":\"or\"}],\"logic\":\"and\"},\"skip\":0,\"take\":4,\"sort\":[{\"dir\":\"asc\",\"field\":\"name\"}]}}" } } }, "responses": { "200": { "description": "Returns a mini-list of Vrrp System Nodes matching the search criteria", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total number of search results", "type": "integer" }, "data": { "description": "An array of System Node search results.", "type": "array", "items": { "$ref": "#/components/schemas/ListVrrpSystemNodeResponse" } } }, "type": "object" } } } }, "400": { "description": "Invalid request payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tftp/create-directory": { "post": { "tags": [ "TFTP" ], "summary": "An endpoint to create dir in tftp server.", "operationId": "post_app_systemserverarchitecture_port_http_command_tftp_tftpcommand_createdir", "requestBody": { "description": "Request to create a new directory for tftp server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TftpNewDirectoryRequest" } } } }, "responses": { "201": { "description": "dir created successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tftp/remove-item": { "post": { "tags": [ "TFTP" ], "summary": "An endpoint to remove item in tftp server.", "operationId": "post_app_systemserverarchitecture_port_http_command_tftp_tftpcommand_removeitem", "requestBody": { "description": "Request to remove item in tftp server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TftpRemoveItemRequest" } } } }, "responses": { "204": { "description": "item has been deleted" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tftp/upload-file": { "post": { "tags": [ "TFTP" ], "summary": "An endpoint to upload file to tftp server.", "operationId": "post_app_systemserverarchitecture_port_http_command_tftp_tftpcommand_create", "requestBody": { "description": "Request to upload a new file to tftp server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TftpFileUploadRequest" } } } }, "responses": { "201": { "description": "File uploaded successfully" }, "400": { "description": "Incorrect create payload" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tftp/download-file": { "post": { "tags": [ "TFTP" ], "summary": "An endpoint to download file from tftp .", "operationId": "post_app_systemserverarchitecture_port_http_query_tftp_tftpfilequery_download", "requestBody": { "description": "Request to download file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TftpDownloadFileRequest" } } } }, "responses": { "200": { "description": "file downloaded successfully" }, "400": { "description": "Incorrect create payload" }, "404": { "description": "Not found file" }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tftp/dir-structure": { "get": { "tags": [ "TFTP" ], "summary": "An endpoint to read a file system.", "operationId": "get_app_systemserverarchitecture_port_http_query_tftp_tftpquery_getdirstructure", "responses": { "200": { "description": "Returns the result of file system.", "content": { "application/json": { "schema": { "properties": { "root": { "type": "string", "example": [] } }, "type": "object" } } } }, "404": { "description": "Directory structure not found." }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } }, "/api/v3/tftp/dir-content": { "post": { "tags": [ "TFTP" ], "summary": "An endpoint to read dir content.", "operationId": "post_app_systemserverarchitecture_port_http_query_tftp_tftpquery_getdircontent", "requestBody": { "description": "JSON object containing data to search for Directory content.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TftpDirContentRequest" } } } }, "responses": { "400": { "description": "Incorrect data to get." }, "200": { "description": "return list of files in directory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileContentResponse" } } } }, "401": { "description": "Missing JWT", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid JWT Token" } }, "type": "object" } } } }, "403": { "description": "Area only for admin", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "You are not authorized to this area" } }, "type": "object" } } } } } } } }, "components": { "schemas": { "NotificationTemplatesKeysTranslationEnum": { "description": "Available placeholder keys for notification templates (use in body/subject as {{ KEY }}).", "type": "string", "enum": [ "reset_password.password_reset_token", "identity_reset_password_sms.password_reset_token", "identity_reset_password.password_reset_token", "inactive_account.inactive_username", "inactive_account.date_time", "inactive_account.host", "vpn_client_configuration.vpn_client_configuration", "vpn_client_configuration.password", "wifi_password_access.wifi_password", "certificate_pki_client.certificate_pki_client", "cp_account_activation.name", "cp_account_activation.surname", "cp_account_activation.email", "cp_account_activation.telephone_number", "cp_account_activation.url", "cp_account_activation.form_extra_fields", "account_activated.login", "account_activated.password", "account_activated_sms.login", "account_activated_sms.password", "account_activated.nacview_secret", "account_activated.google_secret", "token_mfa_email.username", "token_mfa_email.token", "token_mfa_sms.token", "custom_email.body", "core_template.body", "core_template.title" ] }, "SystemStatusKeysTranslationEnum": { "description": "Available placeholder keys for system status.", "type": "string", "enum": [ "status.cannot_connect_to_sms_server", "status.sms_incorrect_configuration", "status.cannot_connect_to_smtp_server", "status.license_expired", "status.license_expire_soon", "status.disk_actual_usage", "status.certificate_expired", "status.certificate_expire_soon", "status.ca_not_generated", "status.ca_needs_to_be_generated", "status.server_not_generated", "status.server_needs_to_be_generated", "status.key_not_valid", "status.key_not_uploaded", "status.server_not_valid", "status.server_not_uploaded", "status.node_require_configuration_refresh", "no_connection", "failed_ping_server_unreachable", "status.disk.app", "status.disk.root", "status.disk.data", "status.license.name", "status.rebuild_configuration.name" ] }, "CustomMessageCodeTranslationEnum": { "description": "Uncategorized translations.", "type": "string", "enum": [ "missing_user" ] }, "NetworkDeviceStatusErrorCode": { "description": "Network Device status error and warning codes.", "type": "string", "enum": [ "missing_ip_address", "device_not_respond_to_ping", "status_check_not_implemented", "unsupported_device_credential_type", "cli_connection_failed", "missing_device_credential", "missing_login_details", "snmp_connection_failed", "radius_activity_only_in_past", "no_radius_activity", "syslog_activity_only_in_past", "no_syslog_activity" ] }, "ImportTranslationEnum": { "description": "Available translations for import.", "type": "string", "enum": [ "import.status.draft", "import.status.parsed", "import.status.validated", "import.status.decisions_made", "import.status.completed", "import.status.error", "import.status.in_progress", "import.validation_error.object_exists", "import.validation_error.reference_not_found", "import.validation_error.invalid_value", "import.validation_error.required_field", "import.validation_error.duplicate_value" ] }, "UpdateGroupActionsRequest": { "required": [ "field", "value", "updatingIds" ], "properties": { "field": { "type": "string", "maxLength": 255 }, "value": { "type": "mixed", "example": "any" }, "collectionActionType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CollectionActionType" } ] }, "updatingIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "RemoveGroupActionsRequest": { "required": [ "removingIds" ], "properties": { "removingIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "ViewArchiveResponse": { "required": [ "id", "createdAt", "type", "objectName", "objectId", "context" ], "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "type": { "type": "string" }, "objectName": { "type": "string" }, "routeName": { "type": "string", "nullable": true }, "route": { "type": "string", "nullable": true }, "objectId": { "type": "integer" }, "context": { "type": "array", "items": {} } }, "type": "object" }, "ListArchiveResponse": { "required": [ "id", "createdAt", "type", "objectName" ], "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "type": { "type": "string" }, "objectName": { "type": "string" }, "routeName": { "type": "string", "nullable": true }, "route": { "type": "string", "nullable": true } }, "type": "object" }, "ViewGlobalConfigurationResponse": { "required": [ "isSnmpEnabled", "snmpDisconnectTimeout", "isPasswordOfTheDayNotify", "radiusCacheTime", "reportIsEnabled1", "reportIsEnabled2", "reportIsEnabled3", "reportIsEnabled4", "reportIsEnabled5", "isSupersetAccess1", "isSupersetAccess2", "isSupersetAccess3", "isSupersetAccess4", "isSupersetAccess5" ], "properties": { "isSnmpEnabled": { "type": "boolean" }, "snmpDisconnectTimeout": { "type": "integer" }, "isPasswordOfTheDayNotify": { "type": "boolean" }, "radiusCacheTime": { "type": "integer" }, "reportLabel1": { "type": "string", "nullable": true }, "reportLabel2": { "type": "string", "nullable": true }, "reportLabel3": { "type": "string", "nullable": true }, "reportLabel4": { "type": "string", "nullable": true }, "reportLabel5": { "type": "string", "nullable": true }, "yubikeyClientId": { "type": "string", "nullable": true }, "yubikeyClientKey": { "type": "string", "nullable": true }, "yubikeyHosts": { "type": "array", "items": { "type": "string" }, "nullable": true }, "reportIsEnabled1": { "type": "boolean" }, "reportIsEnabled2": { "type": "boolean" }, "reportIsEnabled3": { "type": "boolean" }, "reportIsEnabled4": { "type": "boolean" }, "reportIsEnabled5": { "type": "boolean" }, "zabbixIpAddress": { "type": "string", "nullable": true }, "supersetAccessGroups1": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "supersetAccessGroups2": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "supersetAccessGroups3": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "supersetAccessGroups4": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "supersetAccessGroups5": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isSupersetAccess1": { "type": "boolean" }, "isSupersetAccess2": { "type": "boolean" }, "isSupersetAccess3": { "type": "boolean" }, "isSupersetAccess4": { "type": "boolean" }, "isSupersetAccess5": { "type": "boolean" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "macAddressCustom1": { "type": "string", "default": null, "nullable": true }, "macAddressCustom2": { "type": "string", "default": null, "nullable": true }, "macAddressCustom3": { "type": "string", "default": null, "nullable": true }, "macAddressCustom4": { "type": "string", "default": null, "nullable": true }, "identityCustom1": { "type": "string", "default": null, "nullable": true }, "identityCustom2": { "type": "string", "default": null, "nullable": true }, "identityCustom3": { "type": "string", "default": null, "nullable": true }, "identityCustom4": { "type": "string", "default": null, "nullable": true }, "endpointDeviceCustom1": { "type": "string", "default": null, "nullable": true }, "endpointDeviceCustom2": { "type": "string", "default": null, "nullable": true }, "endpointDeviceCustom3": { "type": "string", "default": null, "nullable": true }, "endpointDeviceCustom4": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "GlobalConfigurationRequest": { "required": [ "isSnmpEnabled", "snmpDisconnectTimeout", "isPasswordOfTheDayNotify", "radiusCacheTime", "reportIsEnabled1", "reportIsEnabled2", "reportIsEnabled3", "reportIsEnabled4", "reportIsEnabled5" ], "properties": { "isSnmpEnabled": { "type": "boolean", "example": true }, "snmpDisconnectTimeout": { "type": "integer", "minimum": 0, "example": "5" }, "isPasswordOfTheDayNotify": { "type": "boolean", "example": true }, "radiusCacheTime": { "type": "integer", "example": 20 }, "reportLabel1": { "type": "string", "nullable": true }, "reportLabel2": { "type": "string", "nullable": true }, "reportLabel3": { "type": "string", "nullable": true }, "reportLabel4": { "type": "string", "nullable": true }, "reportLabel5": { "type": "string", "nullable": true }, "yubikeyClientId": { "type": "string", "nullable": true }, "yubikeyClientKey": { "type": "string", "nullable": true }, "yubikeyHosts": { "description": "Yubikey hosts", "type": "array", "items": { "type": "string" }, "example": [ "10.11.10.1", "10.14.10.8" ], "nullable": true }, "supersetAccessGroups1": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "supersetAccessGroups2": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "supersetAccessGroups3": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "supersetAccessGroups4": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "supersetAccessGroups5": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "zabbixIpAddress": { "type": "string", "maxLength": 100, "nullable": true }, "reportIsEnabled1": { "type": "boolean", "example": true }, "reportIsEnabled2": { "type": "boolean", "example": true }, "reportIsEnabled3": { "type": "boolean", "example": true }, "reportIsEnabled4": { "type": "boolean", "example": true }, "reportIsEnabled5": { "type": "boolean", "example": true }, "macAddressCustom1": { "type": "string", "maxLength": 225, "nullable": true }, "macAddressCustom2": { "type": "string", "maxLength": 225, "nullable": true }, "macAddressCustom3": { "type": "string", "maxLength": 225, "nullable": true }, "macAddressCustom4": { "type": "string", "maxLength": 225, "nullable": true }, "identityCustom1": { "type": "string", "maxLength": 225, "nullable": true }, "identityCustom2": { "type": "string", "maxLength": 225, "nullable": true }, "identityCustom3": { "type": "string", "maxLength": 225, "nullable": true }, "identityCustom4": { "type": "string", "maxLength": 225, "nullable": true }, "endpointDeviceCustom1": { "type": "string", "maxLength": 225, "nullable": true }, "endpointDeviceCustom2": { "type": "string", "maxLength": 225, "nullable": true }, "endpointDeviceCustom3": { "type": "string", "maxLength": 225, "nullable": true }, "endpointDeviceCustom4": { "type": "string", "maxLength": 225, "nullable": true } }, "type": "object" }, "AllExceptionMessageCodesResponse": { "required": [ "messageCodes" ], "properties": { "messageCodes": { "type": "array", "items": { "$ref": "#/components/schemas/HttpExceptionMessageCodeEnum" } } }, "type": "object" }, "NacviewAssistantRequest": { "required": [ "name", "pki" ], "properties": { "name": { "description": "Name of nacview assistant", "type": "string", "maxLength": 255, "minLength": 1, "example": "Android PEAP" }, "description": { "description": "Description of nacview assistant", "type": "string", "maxLength": 4096, "example": "Description of nacview assistant", "nullable": true }, "domain": { "description": "IP address od server", "type": "string", "maxLength": 255, "example": "10.10.0.26", "nullable": true }, "messageInfo": { "description": "Configuration message", "type": "string", "maxLength": 255, "example": "You get here because someone gave you access to the network", "nullable": true }, "messageError": { "description": "Message about incorrect upload of the structure", "type": "string", "maxLength": 255, "example": "Invalid configuration", "nullable": true }, "messageSuccess": { "description": "Message about successful configuration upload", "type": "string", "maxLength": 255, "example": "The configuration has been installed correctly", "nullable": true }, "isEnabled": { "description": "Is it active?", "type": "boolean", "default": true, "example": false }, "os": { "$ref": "#/components/schemas/OperationSystem" }, "type": { "$ref": "#/components/schemas/NacviewAssistantType" }, "validFrom": { "description": "valid from", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "validTo": { "description": "valid to", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "pki": { "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "wifiNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewNacviewAssistantResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "type", "os", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true }, "messageInfo": { "type": "string", "nullable": true }, "messageError": { "type": "string", "nullable": true }, "messageSuccess": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "type": { "$ref": "#/components/schemas/NacviewAssistantType" }, "os": { "$ref": "#/components/schemas/OperationSystem" }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "wifiNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListWifiNetworkResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewPasswordConfigurationResponse": { "required": [ "adminPasswordPolicy", "adminLoginAllowedIps", "adminMfaAllowedList" ], "properties": { "adminPasswordPolicy": { "$ref": "#/components/schemas/PasswordConfigurationPolicyEnum" }, "forcePasswordChangeInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PasswordConfigurationForceChangeIntervalEnum" } ] }, "adminLoginAllowedIps": { "type": "array", "items": { "type": "string" } }, "adminMfaAllowedList": { "type": "array", "items": { "$ref": "#/components/schemas/MfaType" } }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "UpdatePasswordConfigurationRequest": { "required": [ "adminPasswordPolicy", "adminMfaAllowedList" ], "properties": { "adminPasswordPolicy": { "$ref": "#/components/schemas/PasswordConfigurationPolicyEnum" }, "forcePasswordChangeInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PasswordConfigurationForceChangeIntervalEnum" } ] }, "adminLoginAllowedIps": { "description": "Array of ips with mask", "type": "array", "items": { "description": "IP", "type": "string" }, "example": "[\"10.10.0.0/16\", \"214.16.128.0/24\"]", "nullable": true }, "adminMfaAllowedList": { "type": "array", "items": { "$ref": "#/components/schemas/MfaType" } } }, "type": "object" }, "ViewUserResponse": { "required": [ "accessType", "id", "authorizationServer", "username", "name", "surname", "email", "isEnabled", "createdAt", "isBuiltIn", "nacviewSecret", "googleSecret", "isMfaRequired" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "username": { "type": "string" }, "name": { "type": "string" }, "surname": { "type": "string" }, "email": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true }, "lastLoginDate": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "telephoneNumber": { "type": "string", "nullable": true }, "isExternalTacacsPassword": { "type": "boolean", "nullable": true }, "isEnabled": { "type": "boolean" }, "externalIntegrationId": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isBuiltIn": { "type": "boolean" }, "updatedAt": { "type": "string", "nullable": true }, "nacviewSecret": { "type": "string" }, "googleSecret": { "type": "string" }, "yubiToken": { "type": "string", "nullable": true }, "externalIntegrationUid": { "type": "string", "nullable": true }, "isMfaRequired": { "type": "boolean" } }, "type": "object" }, "EditUserRequest": { "required": [ "username", "name", "surname", "email" ], "properties": { "username": { "description": "username of the user", "type": "string", "maxLength": 50, "example": "admin@nacview.com" }, "name": { "description": "name of the user", "type": "string", "maxLength": 50, "example": "admin" }, "surname": { "description": "surname of the user", "type": "string", "maxLength": 50, "example": "nac operator" }, "email": { "description": "email of the user", "type": "string", "maxLength": 50, "example": "admin@nacview.com" }, "expiryDate": { "description": "expiry date of the user account", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "telephoneNumber": { "description": "telephone number of the user", "type": "string", "maxLength": 15, "minLength": 9, "example": "123456789", "nullable": true }, "isExternalTacacsPassword": { "description": "is enabled or not", "type": "boolean", "default": false, "example": true }, "isMfaRequired": { "description": "is MFA active", "type": "boolean", "default": false, "example": true }, "isEnabled": { "description": "is enabled or not", "type": "boolean", "default": false, "example": true }, "password": { "description": "User password", "type": "string", "maxLength": 255, "minLength": 8, "example": "P4ssw0rd", "nullable": true }, "tacacsPassword": { "description": "User tacacs password", "type": "string", "maxLength": 255, "minLength": 8, "example": "P4ssw0rd", "nullable": true }, "yubiToken": { "description": "Yubi Token", "type": "string", "maxLength": 45, "minLength": 12, "example": "JBSWY3DPEHPK3PXP ", "nullable": true } }, "type": "object" }, "NewUserRequest": { "required": [ "authorizationServer", "username", "name", "surname", "email" ], "properties": { "authorizationServer": { "$ref": "#/components/schemas/NestedIdentifier" }, "username": { "description": "username of the user", "type": "string", "maxLength": 50, "example": "admin@nacview.com" }, "name": { "description": "name of the user", "type": "string", "maxLength": 50, "example": "admin" }, "surname": { "description": "surname of the user", "type": "string", "maxLength": 50, "example": "nac operator" }, "email": { "description": "email of the user", "type": "string", "maxLength": 50, "example": "admin@nacview.com" }, "expiryDate": { "description": "expiry date of the user account", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "description": { "description": "description of the user", "type": "string", "maxLength": 4096, "example": "description of new user", "nullable": true }, "telephoneNumber": { "description": "telephone number of the user", "type": "string", "maxLength": 15, "minLength": 9, "example": "+48123456789", "nullable": true }, "isExternalTacacsPassword": { "description": "is enabled or not", "type": "boolean", "default": false, "example": true }, "yubiToken": { "description": "Yubi Token", "type": "string", "maxLength": 45, "minLength": 12, "example": "JBSWY3DPEHPK3PXP ", "nullable": true }, "isEnabled": { "description": "is enabled or not", "type": "boolean", "default": false, "example": true }, "password": { "description": "User password", "type": "string", "maxLength": 255, "minLength": 8, "example": "P4ssw0rd", "nullable": true }, "tacacsPassword": { "type": "string", "maxLength": 255, "minLength": 8, "nullable": true }, "isMfaRequired": { "description": "is MFA active", "type": "boolean", "default": false, "example": true } }, "type": "object" }, "PreferencesUserResponse": { "required": [ "preferences" ], "properties": { "preferences": { "description": "Arbitrary JSON object fully controlled by frontend", "type": "object", "example": "{\n \"theme\": \"dark\",\n \"layout\": \"compact\",\n \"notifications\": {\n \"email\": true,\n \"push\": false\n }\n }", "additionalProperties": true } }, "type": "object" }, "UserPreferencesRequest": { "properties": { "preferences": { "description": "JSON value to store custom user settings", "type": "string", "default": null, "maxLength": 4096 } }, "type": "object" }, "ViewUserPasswordTacacsSettingsResponse": { "required": [ "isExternalTacacsPassword", "nacviewSecret", "googleSecret", "authorizationServer" ], "properties": { "isExternalTacacsPassword": { "type": "boolean" }, "tacacsPasswordLastChangeDate": { "type": "string", "nullable": true }, "yubiToken": { "type": "string", "nullable": true }, "nacviewSecret": { "type": "string" }, "googleSecret": { "type": "string" }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" } }, "type": "object" }, "UserSecuritySetting": { "properties": { "tacacsPassword": { "description": "Set new password to tacacs", "type": "string", "maxLength": 225, "minLength": 3, "example": "newPassword12", "nullable": true }, "password": { "description": "Set new password to web panel", "type": "string", "maxLength": 225, "minLength": 3, "example": "newPassword12", "nullable": true }, "yubiToken": { "description": "Set new secret key of yubikey", "type": "string", "maxLength": 45, "minLength": 12, "example": "ccccrwculljeiretejbeidcfdktlbbinerhhgkevjfcr", "nullable": true }, "isExternalTacacsPassword": { "description": "Activate tacacs password", "type": "boolean", "example": "true", "nullable": true } }, "type": "object" }, "UserRefreshMfaRequest": { "properties": { "refreshNacviewSecret": { "description": "flag to refresh nacview secret", "type": "boolean", "default": false, "example": true }, "refreshGoogleSecret": { "description": "flag to refresh google authenticator secret", "type": "boolean", "default": false, "example": true } }, "type": "object" }, "NacviewAssistantConfigurationRequest": { "required": [ "filename", "identity" ], "properties": { "filename": { "type": "string", "maxLength": 255 }, "identity": { "$ref": "#/components/schemas/NestedIdentifier" } }, "type": "object" }, "ListNacviewAssistantResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "type", "os", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "type": { "$ref": "#/components/schemas/NacviewAssistantType" }, "os": { "$ref": "#/components/schemas/OperationSystem" }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "wifiNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListWifiNetworkResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListNacviewAssistantResponse": { "required": [ "id", "name", "isEnabled", "type", "os" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/NacviewAssistantType" }, "os": { "$ref": "#/components/schemas/OperationSystem" } }, "type": "object" }, "AvailableFilesResponse": { "required": [ "file", "type", "os" ], "properties": { "file": { "type": "string" }, "wifi": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/NacviewAssistantType" }, "os": { "$ref": "#/components/schemas/OsType" } }, "type": "object" }, "ListResourceRoutesResponse": { "required": [ "name" ], "properties": { "name": { "type": "string" } }, "type": "object" }, "ListUserResponse": { "required": [ "id", "username", "name", "surname", "email", "isEnabled", "authorizationServer", "createdAt", "isBuiltIn", "isExternalTacacsPassword", "accessType" ], "properties": { "id": { "type": "integer" }, "username": { "type": "string" }, "name": { "type": "string" }, "surname": { "type": "string" }, "email": { "type": "string" }, "isEnabled": { "type": "boolean" }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "externalIntegrationId": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isBuiltIn": { "type": "boolean" }, "telephoneNumber": { "type": "string", "nullable": true }, "isExternalTacacsPassword": { "type": "boolean" }, "googleSecret": { "type": "string", "nullable": true }, "nacviewSecret": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListUserResponse": { "required": [ "id", "username", "name", "surname", "email", "isEnabled" ], "properties": { "id": { "type": "integer" }, "username": { "type": "string" }, "name": { "type": "string" }, "surname": { "type": "string" }, "email": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "CurrentUserSettingsResponse": { "required": [ "id", "username", "name", "surname", "email", "isEnabled", "isSupersetAccess1", "isSupersetAccess2", "isSupersetAccess3", "isSupersetAccess4", "isSupersetAccess5" ], "properties": { "id": { "type": "integer" }, "username": { "type": "string" }, "name": { "type": "string" }, "surname": { "type": "string" }, "email": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isSupersetAccess1": { "type": "boolean" }, "isSupersetAccess2": { "type": "boolean" }, "isSupersetAccess3": { "type": "boolean" }, "isSupersetAccess4": { "type": "boolean" }, "isSupersetAccess5": { "type": "boolean" } }, "type": "object" }, "ResetPasswordTokenRequest": { "required": [ "email" ], "properties": { "email": { "description": "Email", "type": "string", "example": "admin@nacview.com" } }, "type": "object" }, "NewPasswordRequest": { "required": [ "email", "token", "csrf", "newPassword" ], "properties": { "email": { "description": "Email", "type": "string", "example": "admin@nacview.com" }, "token": { "description": "token", "type": "string", "example": "12qwg4r" }, "csrf": { "description": "csrf", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "newPassword": { "description": "new password", "type": "string", "maxLength": 255, "minLength": 8, "example": "Nice-hard-p4ssw0rd" } }, "type": "object" }, "MfaRequiredForLoginResponse": { "required": [ "sessionToken", "mfaTypes", "csrf" ], "properties": { "sessionToken": { "type": "string" }, "mfaTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MfaType" } }, "csrf": { "type": "string" } }, "type": "object" }, "MfaAuthenticationRequest": { "required": [ "tokenMfa", "mfaType", "sessionToken", "csrf" ], "properties": { "tokenMfa": { "description": "Token MFA", "type": "string", "maxLength": 50, "minLength": 6, "example": "421512" }, "mfaType": { "$ref": "#/components/schemas/MfaType" }, "sessionToken": { "description": "Token CSRF", "type": "string", "example": "421512-2144-4123421-112344" }, "csrf": { "description": "Token CSRF", "type": "string", "example": "421512-2144-4123421-112344" } }, "type": "object" }, "CsrfMessageResponse": { "required": [ "message", "csrf" ], "properties": { "message": { "type": "string" }, "csrf": { "type": "string" } }, "type": "object" }, "SendMfaAuthenticationTokenRequest": { "required": [ "mfaType", "sessionToken", "csrf" ], "properties": { "mfaType": { "$ref": "#/components/schemas/MfaType" }, "sessionToken": { "description": "Token CSRF", "type": "string", "example": "421512-2144-4123421-112344" }, "csrf": { "description": "Token CSRF", "type": "string", "example": "421512-2144-4123421-112344" } }, "type": "object" }, "ListUserAccessToRouteResponse": { "required": [ "resourceRoute", "methods" ], "properties": { "resourceRoute": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "AccessGroupRequest": { "required": [ "name", "isEnabled" ], "properties": { "name": { "description": "Name of group", "type": "string", "maxLength": 255, "example": "Visitor" }, "isFullAccess": { "description": "is granted to all", "type": "boolean", "default": false, "example": true }, "isEnabled": { "type": "boolean" }, "description": { "description": "description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "permissionsRouters": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionsRouterValidatorRequest" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "defaultObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewAccessGroupResponse": { "required": [ "accessType", "id", "name", "isEnabled", "isFullAccess", "isBuiltIn", "createdAt" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isFullAccess": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListUserResponse" }, "nullable": true }, "permissionsRouters": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionRouterResponse" }, "nullable": true }, "defaultObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true } }, "type": "object" }, "ListAccessGroupResponse": { "required": [ "accessType", "id", "name", "isEnabled", "isFullAccess", "isBuiltIn", "createdAt" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isFullAccess": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "createdAt": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListUserResponse" }, "nullable": true }, "defaultObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true } }, "type": "object" }, "MiniListAccessGroupResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "MatrixPolicyRequest": { "required": [ "name", "sector", "type" ], "properties": { "name": { "description": "Name of policy", "type": "string", "maxLength": 100, "example": "string" }, "description": { "description": "description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is policy enabled", "type": "boolean", "default": true, "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "sector": { "$ref": "#/components/schemas/NestedIdentifier" }, "type": { "$ref": "#/components/schemas/MatrixType" }, "networkAccessQuarantineResult": { "description": "network access quarantine result", "type": "integer", "maximum": 4096, "minimum": 0, "example": 1, "nullable": true }, "vpnAccessQuarantineResult": { "description": "vpn access quarantine result", "type": "integer", "maximum": 4096, "minimum": 0, "example": 1, "nullable": true }, "isAccountLockout": { "description": "is account lockout", "type": "boolean", "default": false, "example": false }, "accountMaxFailures": { "description": "account max failures", "type": "integer", "example": 1, "nullable": true }, "accountLockoutWithin": { "description": "account lockout within in minutes", "type": "integer", "maximum": 60, "minimum": 1, "example": 1, "nullable": true }, "accountBlockPeriod": { "description": "account block period in minutes", "type": "integer", "maximum": 3600, "minimum": 5, "example": 1, "nullable": true } }, "type": "object" }, "ViewMatrixPolicyResponse": { "required": [ "id", "name", "isEnabled", "isInstalled", "sector", "type", "isActive", "isAccountLockout", "accountMaxFailures", "accountBlockPeriod", "accountLockoutWithin", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isInstalled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "sector": { "$ref": "#/components/schemas/MiniListSectorResponse" }, "type": { "$ref": "#/components/schemas/MatrixType" }, "isActive": { "type": "boolean" }, "networkAccessQuarantineResult": { "type": "integer", "nullable": true }, "vpnAccessQuarantineResult": { "type": "integer", "nullable": true }, "isAccountLockout": { "type": "boolean" }, "accountMaxFailures": { "type": "integer" }, "accountBlockPeriod": { "type": "integer" }, "accountLockoutWithin": { "type": "integer" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "nameInstalled": { "type": "string", "nullable": true }, "isEnabledInstalled": { "type": "boolean", "nullable": true }, "descriptionInstalled": { "type": "string", "nullable": true }, "networkAccessQuarantineResultInstalled": { "type": "integer", "nullable": true }, "vpnAccessQuarantineResultInstalled": { "type": "integer", "nullable": true }, "isAccountLockoutInstalled": { "type": "boolean", "nullable": true }, "accountMaxFailuresInstalled": { "type": "integer", "nullable": true }, "accountBlockPeriodInstalled": { "type": "integer", "nullable": true }, "accountLockoutWithinInstalled": { "type": "integer", "nullable": true }, "matrixPolicyRules": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "CloneMatrixPolicyRequest": { "required": [ "name" ], "properties": { "name": { "description": "Name of policy", "type": "string", "maxLength": 100, "example": "string" } }, "type": "object" }, "ReorderMatrixPolicyRequest": { "required": [ "matrixPolicyRules" ], "properties": { "matrixPolicyRules": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" } } }, "type": "object" }, "MatrixPolicyCategoryRequest": { "required": [ "name" ], "properties": { "name": { "description": "Name of policy category", "type": "string", "maxLength": 100, "example": "string" }, "description": { "description": "description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is policy category enabled", "type": "boolean", "default": true, "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewMatrixPolicyCategoryResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "matrixPolicyRules": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MatrixPolicyOptionRequest": { "required": [ "name" ], "properties": { "name": { "description": "Name of policy option", "type": "string", "maxLength": 100, "example": "string" }, "description": { "description": "description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is policy enabled", "type": "boolean", "default": true, "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewMatrixPolicyOptionResponse": { "required": [ "id", "name", "isEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } }, "matrixPolicyOptionsItems": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionItemResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "type": "object" }, "MatrixPolicyOptionItemRequest": { "required": [ "name", "op" ], "properties": { "name": { "description": "Name of policy", "type": "string", "maxLength": 100, "example": "string" }, "value": { "description": "value of policy option", "type": "string", "maxLength": 255, "example": "string", "nullable": true }, "dynamicValue": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DynamicValue" } ] }, "isEnabled": { "description": "is policy enabled", "type": "boolean", "default": true, "example": false }, "op": { "$ref": "#/components/schemas/DhcpOptionOperator" }, "isLocalCaptivePortal": { "description": "is local captive portal", "type": "boolean", "default": false, "example": false } }, "type": "object" }, "ViewMatrixPolicyOptionItemResponse": { "required": [ "id", "name", "isEnabled", "isLocalCaptivePortal", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "dynamicValue": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DynamicValue" } ] }, "isEnabled": { "type": "boolean" }, "op": { "type": "string", "nullable": true }, "isLocalCaptivePortal": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "MatrixPolicyProfileActionRequest": { "required": [ "name", "type", "actionType", "httpType" ], "properties": { "name": { "description": "Name of policy profile action", "type": "string", "maxLength": 100, "example": "string" }, "isEnabled": { "description": "is policy profile action enabled", "type": "boolean", "default": true, "example": false }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "type": { "$ref": "#/components/schemas/MatrixPolicyProfileActionType" }, "actionType": { "$ref": "#/components/schemas/ActionType" }, "isBlocked": { "description": "is policy enabled", "type": "boolean", "default": true, "example": false }, "blockedTimeout": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BlockedTimeout" } ] }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "httpStartUrl": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "httpStartHeader": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "httpStartData": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "httpType": { "$ref": "#/components/schemas/HttpType" }, "httpStopUrl": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "httpStopHeader": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "httpStopData": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "notifySmsData": { "description": "Name of http Start Url", "type": "string", "maxLength": 255, "example": "string", "nullable": true }, "notifyEmailData": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "notifySyslogData": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true }, "scriptData": { "description": "Name of http Start Url", "type": "string", "maxLength": 2048, "example": "string", "nullable": true } }, "type": "object" }, "ViewMatrixPolicyProfileActionResponse": { "required": [ "id", "name", "isEnabled", "type", "actionType", "isBlocked", "httpType", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/MatrixPolicyProfileActionType" }, "actionType": { "$ref": "#/components/schemas/ActionType" }, "isBlocked": { "type": "boolean" }, "blockedTimeout": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BlockedTimeout" } ] }, "httpStartUrl": { "type": "string", "nullable": true }, "httpStartHeader": { "type": "string", "nullable": true }, "httpStartData": { "type": "string", "nullable": true }, "httpType": { "$ref": "#/components/schemas/HttpType" }, "httpStopUrl": { "type": "string", "nullable": true }, "httpStopHeader": { "type": "string", "nullable": true }, "httpStopData": { "type": "string", "nullable": true }, "notifySmsData": { "type": "string", "nullable": true }, "notifyEmailData": { "type": "string", "nullable": true }, "notifySyslogData": { "type": "string", "nullable": true }, "scriptData": { "type": "string", "nullable": true }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "type": "object" }, "NewMatrixPolicyRuleRequest": { "required": [ "name", "objectType" ], "properties": { "name": { "description": "Name of policy rule", "type": "string", "maxLength": 100, "example": "string" }, "isEnabled": { "description": "is rule enabled", "type": "boolean", "default": true, "example": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "objectType": { "$ref": "#/components/schemas/ObjectType" }, "methodTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MethodTypes" }, "nullable": true }, "isWired": { "description": "is rule wired", "type": "boolean", "default": false, "example": false }, "isWireless": { "description": "is rule wireless", "type": "boolean", "default": false, "example": false }, "wifiNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "matrixPolicyTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "actionType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "captivePortal": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "matrixPolicyProfileActions": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "matrixPolicyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "isAutoLearnDevice": { "description": "is rule wired", "type": "boolean", "default": false, "example": false }, "autoLearnObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "vpnSmsMessage": { "description": "VPN sms message", "type": "string", "example": "string", "nullable": true }, "vpnReplyMessage": { "description": "VPN reply message", "type": "string", "example": "string", "nullable": true }, "vpnTimeout": { "description": "vpm timeout time in seconds", "type": "integer", "example": 600, "nullable": true }, "vpnVerificationType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnVerificationType" } ] }, "identityConditions": { "description": "condition for identity", "type": "string", "example": "{\"filters\":[],\"logic\":\"and\"}", "nullable": true }, "endpointDeviceConditions": { "description": "condition for endpoint device", "type": "string", "example": "{\"filters\":[],\"logic\":\"and\"}", "nullable": true }, "networkDeviceConditions": { "description": "condition for network device", "type": "string", "example": "{\"filters\":[],\"logic\":\"and\"}", "nullable": true }, "vpnType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnType" } ] }, "captivePortalResult": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] } }, "type": "object" }, "ViewMatrixPolicyRuleResponse": { "required": [ "matrixPolicy", "id", "name", "isEnabled", "accessType", "sequencer", "isDeleted", "objectType", "methodTypes", "isWired", "isWireless", "isAutoLearnDevice", "isDeletedInstalled" ], "properties": { "matrixPolicy": { "$ref": "#/components/schemas/MiniListMatrixPolicyResponse" }, "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListColorIdentifierResponse" } ] }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] }, "sequencer": { "type": "integer" }, "isDeleted": { "type": "boolean" }, "objectType": { "$ref": "#/components/schemas/ObjectType" }, "methodTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MethodTypes" } }, "isWired": { "type": "boolean" }, "isWireless": { "type": "boolean" }, "wifiNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListWifiNetworkResponse" }, "nullable": true }, "identityConditions": { "type": "string", "nullable": true }, "endpointDeviceConditions": { "type": "string", "nullable": true }, "networkDeviceConditions": { "type": "string", "nullable": true }, "matrixPolicyTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyTimeResponse" } ] }, "actionType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "captivePortal": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" } ] }, "matrixPolicyProfileActions": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionItemResponse" }, "nullable": true }, "matrixPolicyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionResponse" }, "nullable": true }, "isAutoLearnDevice": { "type": "boolean" }, "autoLearnObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "vpnSmsMessage": { "type": "string", "nullable": true }, "vpnReplyMessage": { "type": "string", "nullable": true }, "vpnTimeout": { "type": "integer", "nullable": true }, "vpnType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnType" } ] }, "vpnVerificationType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnVerificationType" } ] }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "nameInstalled": { "type": "string", "nullable": true }, "isDeletedInstalled": { "type": "boolean" }, "descriptionInstalled": { "type": "string", "nullable": true }, "isEnabledInstalled": { "type": "boolean", "nullable": true }, "sequencerInstalled": { "type": "integer", "nullable": true }, "isWiredInstalled": { "type": "boolean", "nullable": true }, "isWirelessInstalled": { "type": "boolean", "nullable": true }, "isAutoLearnDeviceInstalled": { "type": "boolean", "nullable": true }, "actionTypeInstalled": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] }, "colorIdentifierIdInstalled": { "type": "integer", "nullable": true }, "vlanIdInstalled": { "type": "integer", "nullable": true }, "captivePortalIdInstalled": { "type": "integer", "nullable": true }, "matrixPolicyCategoryIdInstalled": { "type": "integer", "nullable": true }, "matrixPolicyTimeIdInstalled": { "type": "integer", "nullable": true }, "vpnSmsMessageInstalled": { "type": "string", "nullable": true }, "vpnReplyMessageInstalled": { "type": "string", "nullable": true }, "vpnTimeoutInstalled": { "type": "integer", "nullable": true }, "vpnTypeInstalled": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnType" } ] }, "vpnVerificationTypeInstalled": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnVerificationType" } ] }, "methodTypesInstalled": { "type": "array", "items": { "$ref": "#/components/schemas/MethodTypes" }, "nullable": true }, "objectTypeInstalled": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ObjectType" } ] }, "wifiNetworksInstalled": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListWifiNetworkResponse" }, "nullable": true }, "matrixPolicyProfileActionsInstalled": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionItemResponse" }, "nullable": true }, "captivePortalResult": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] }, "captivePortalResultInstalled": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] } }, "type": "object" }, "EditMatrixPolicyRuleRequest": { "required": [ "name", "objectType" ], "properties": { "name": { "description": "Name of rule", "type": "string", "maxLength": 100, "example": "string" }, "isEnabled": { "description": "is rule enabled", "type": "boolean", "default": true, "example": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "objectType": { "$ref": "#/components/schemas/ObjectType" }, "methodTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MethodTypes" }, "nullable": true }, "isWired": { "description": "is rule wired", "type": "boolean", "default": false, "example": false }, "isWireless": { "description": "is rule wireless", "type": "boolean", "default": false, "example": false }, "wifiNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "matrixPolicyTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "actionType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "captivePortal": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "matrixPolicyProfileActions": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "matrixPolicyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "isAutoLearnDevice": { "description": "is rule wired", "type": "boolean", "default": false, "example": false }, "autoLearnObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "vpnSmsMessage": { "description": "Vpn sms message", "type": "string", "example": "string", "nullable": true }, "vpnReplyMessage": { "description": "VPN reply message", "type": "string", "example": "string", "nullable": true }, "vpnTimeout": { "description": "vpm timeout time in seconds", "type": "integer", "example": 600, "nullable": true }, "vpnVerificationType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnVerificationType" } ] }, "identityConditions": { "description": "condition for identity", "type": "string", "example": "{\"filters\":[],\"logic\":\"and\"}", "nullable": true }, "endpointDeviceConditions": { "description": "condition for endpoint device", "type": "string", "example": "{\"filters\":[],\"logic\":\"and\"}", "nullable": true }, "networkDeviceConditions": { "description": "condition for network device", "type": "string", "example": "{\"filters\":[],\"logic\":\"and\"}", "nullable": true }, "vpnType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnType" } ] }, "captivePortalResult": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] } }, "type": "object" }, "CloneMatrixPolicyRuleRequest": { "required": [ "name" ], "properties": { "name": { "description": "Name of copy rule", "type": "string", "maxLength": 100, "example": "string" } }, "type": "object" }, "MatrixPolicyTimeRequest": { "required": [ "name", "isEnabled" ], "properties": { "name": { "description": "Name of policy time", "type": "string", "maxLength": 100, "example": "string" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "weekDays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekDays" }, "nullable": true }, "timeBegin": { "description": "time begin", "type": "string", "example": "00:00", "nullable": true }, "timeEnd": { "description": "time end", "type": "string", "example": "00:00", "nullable": true }, "dateBegin": { "description": "date begin", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "dateEnd": { "description": "date end", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "isEnabled": { "description": "is policy time enabled", "type": "boolean", "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewMatrixPolicyTimeResponse": { "required": [ "id", "name", "isEnabled", "weekDays", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "weekDays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekDays" } }, "timeBegin": { "type": "string", "nullable": true }, "timeEnd": { "type": "string", "nullable": true }, "dateBegin": { "type": "string", "nullable": true }, "dateEnd": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "matrixPolicyRules": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListMatrixPolicyResponse": { "required": [ "id", "name", "isEnabled", "sector", "type", "isActive", "isInstalled", "isAccountLockout", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "sector": { "$ref": "#/components/schemas/MiniListSectorResponse" }, "type": { "$ref": "#/components/schemas/MatrixType" }, "isActive": { "type": "boolean" }, "isInstalled": { "type": "boolean" }, "networkAccessQuarantineResult": { "type": "integer", "nullable": true }, "vpnAccessQuarantineResult": { "type": "integer", "nullable": true }, "isAccountLockout": { "type": "boolean" }, "createdAt": { "type": "string" }, "matrixPolicyRules": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListMatrixPolicyResponse": { "required": [ "type", "id", "name", "isEnabled", "isActive", "isInstalled" ], "properties": { "type": { "$ref": "#/components/schemas/MatrixType" }, "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isInstalled": { "type": "boolean" } }, "type": "object" }, "TestMatrixPolicyRequest": { "required": [ "methodType", "testType", "networkDevice" ], "properties": { "methodType": { "$ref": "#/components/schemas/MethodTypes" }, "testType": { "$ref": "#/components/schemas/TestMatrixType" }, "identityName": { "description": "Name of identity", "type": "string", "maxLength": 255, "example": "string", "nullable": true }, "endpointDeviceName": { "description": "Name of endpoint device", "type": "string", "maxLength": 255, "example": "string", "nullable": true }, "clientMacAddress": { "description": "mac address of client device", "type": "string", "maxLength": 255, "example": "string", "nullable": true }, "networkDevice": { "$ref": "#/components/schemas/NestedIdentifier" }, "wifiNetwork": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "identityVpnType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MatrixPolicyIdentityMethodType" } ] }, "endpointDeviceVpnType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MatrixPolicyEndpointDeviceMethodType" } ] } }, "type": "object" }, "TestingMatrixPolicyResponse": { "required": [ "status", "rejectReason" ], "properties": { "status": { "$ref": "#/components/schemas/TestMatrixResponse" }, "matrixPolicyRule": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" } ] }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "rejectReason": { "type": "string" } }, "type": "object" }, "ListMatrixPolicyOptionItemResponse": { "required": [ "id", "name", "isEnabled", "isLocalCaptivePortal", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "dynamicValue": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DynamicValue" } ] }, "isEnabled": { "type": "boolean" }, "op": { "type": "string", "nullable": true }, "isLocalCaptivePortal": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "MiniListMatrixPolicyOptionItemResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListMatrixPolicyOptionResponse": { "required": [ "id", "name", "isEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } }, "matrixPolicyOptionsItems": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionItemResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "type": "object" }, "MiniListMatrixPolicyOptionResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListMatrixPolicyProfileActionResponse": { "required": [ "id", "name", "isEnabled", "type", "actionType", "isBlocked", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/MatrixPolicyProfileActionType" }, "actionType": { "$ref": "#/components/schemas/ActionType" }, "isBlocked": { "type": "boolean" }, "blockedTimeout": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BlockedTimeout" } ] }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "nullable": true } }, "type": "object" }, "MiniListMatrixPolicyProfileActionResponse": { "required": [ "type", "actionType", "id", "name", "isEnabled" ], "properties": { "type": { "$ref": "#/components/schemas/MatrixPolicyProfileActionType" }, "actionType": { "$ref": "#/components/schemas/ActionType" }, "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListMatrixPolicyCategoryResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "matrixPolicyRules": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListMatrixPolicyCategoryResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListMatrixPolicyRuleResponse": { "required": [ "matrixPolicy", "id", "name", "isEnabled", "accessType", "sequencer", "isDeleted", "objectType", "methodTypes", "isWired", "isWireless", "isAutoLearnDevice" ], "properties": { "matrixPolicy": { "$ref": "#/components/schemas/MiniListMatrixPolicyResponse" }, "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" } }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListColorIdentifierResponse" } ] }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] }, "sequencer": { "type": "integer" }, "isDeleted": { "type": "boolean" }, "objectType": { "$ref": "#/components/schemas/ObjectType" }, "methodTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MethodTypes" } }, "isWired": { "type": "boolean" }, "isWireless": { "type": "boolean" }, "wifiNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListWifiNetworkResponse" }, "nullable": true }, "identityConditions": { "type": "string", "nullable": true }, "endpointDeviceConditions": { "type": "string", "nullable": true }, "networkDeviceConditions": { "type": "string", "nullable": true }, "matrixPolicyTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyTimeResponse" } ] }, "actionType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "captivePortal": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" } ] }, "matrixPolicyProfileActions": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionItemResponse" }, "nullable": true }, "matrixPolicyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyOptionResponse" }, "nullable": true }, "isAutoLearnDevice": { "type": "boolean" }, "autoLearnObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "vpnSmsMessage": { "type": "string", "nullable": true }, "vpnReplyMessage": { "type": "string", "nullable": true }, "vpnTimeout": { "type": "integer", "nullable": true }, "vpnType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnType" } ] }, "vpnVerificationType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VpnVerificationType" } ] }, "createdAt": { "type": "string", "nullable": true }, "captivePortalResult": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionType2" } ] } }, "type": "object" }, "MiniListMatrixPolicyRuleResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "matrixPolicy": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyResponse" } ] }, "matrixPolicyCategory": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] } }, "type": "object" }, "ListMatrixPolicyTimeResponse": { "required": [ "id", "name", "isEnabled", "weekDays", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "weekDays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekDays" } }, "timeBegin": { "type": "string", "nullable": true }, "timeEnd": { "type": "string", "nullable": true }, "dateBegin": { "type": "string", "nullable": true }, "dateEnd": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "matrixPolicyRules": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListMatrixPolicyTimeResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "AccessGroupExternalIdentifierRequest": { "required": [ "accessGroup", "name", "isEnabled" ], "properties": { "accessGroup": { "$ref": "#/components/schemas/NestedIdentifier" }, "name": { "description": "External group identifier", "type": "string", "maxLength": 1024, "minLength": 1 }, "isEnabled": { "description": "is AccessGroup service enabled", "type": "boolean", "example": true } }, "type": "object" }, "ViewAccessGroupExternalIdentifierResponse": { "required": [ "id", "name", "authorizationServer", "accessGroup", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "accessGroup": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "AuthorizationServerRequest": { "required": [ "name", "isEnabled", "url", "login", "purpose", "dbType", "isDeletedAfterSync", "isSynchroOrganizationUnit", "isDeletedOrganizationUnitAfterSync", "isFollowReferralsOn", "isEditableExternalData", "isSynchroIncrementally", "isGeneratePassword", "isPkiSend", "isPkiAutoGen", "isAutomaticWifiNotify", "isExternalTacacsPassword" ], "properties": { "name": { "description": "Name of Authorization Server", "type": "string" }, "isEnabled": { "description": "Is Authorization Server enabled", "type": "boolean", "example": false }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "url": { "description": "URL of Authorization Server", "type": "string" }, "login": { "description": "Login to Authorization Server", "type": "string" }, "password": { "description": "Password to Authorization Server", "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/AuthorizationServerPurposeEnum" }, "dbType": { "$ref": "#/components/schemas/AuthorizationServerType" }, "dbDriver": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationSeverDbDriverEnum" } ] }, "socialPortalType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationServerSocialPortalTypeEnum" } ] }, "radiusAuthType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationServerRadiusAuthTypeEnum" } ] }, "ldapService": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "integrationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "dbName": { "description": "Database Name to Authorization Server", "type": "string", "nullable": true }, "baseDn": { "description": "Base DN for Authorization Server", "type": "string", "nullable": true }, "loginType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationServerLoginType" } ] }, "secondLoginType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationServerLoginType" } ] }, "synchroInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SynchronizationIntervalEnum" } ] }, "bearerToken": { "description": "Bearer token to Authorization Server", "type": "string", "nullable": true }, "ldapCustomFilter": { "description": "LdapEndpointDevicesFilter in Authorization Server LDAP type", "type": "string", "nullable": true }, "ldapOrganizationUnitsCustomFilter": { "description": "LdapUnitsFilter in Authorization Server LDAP type", "type": "string", "nullable": true }, "isDeletedAfterSync": { "description": "Is Identities deletion synchronization enabled", "type": "boolean" }, "isSynchroOrganizationUnit": { "description": "Is Organization Unit synchronization enabled", "type": "boolean" }, "isDeletedOrganizationUnitAfterSync": { "description": "Is Organization Unit deletion synchronization enabled", "type": "boolean" }, "isFollowReferralsOn": { "description": "Is Follow Referrals enabled", "type": "boolean" }, "isEditableExternalData": { "description": "Is editable External Data enabled", "type": "boolean" }, "isSynchroIncrementally": { "description": "Is Synchronization Incrementally enabled", "type": "boolean" }, "isGeneratePassword": { "description": "Is generate password enabled", "type": "boolean" }, "isPkiSend": { "description": "Is PKI send enabled", "type": "boolean" }, "isPkiAutoGen": { "description": "Is PKI auto generation enabled", "type": "boolean" }, "isAutomaticWifiNotify": { "description": "Is automatic WiFi notification enabled", "type": "boolean" }, "isExternalTacacsPassword": { "description": "Is TACACS+ password enabled", "type": "boolean" }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "custom1": { "description": "Custom 1", "type": "string", "maxLength": 255, "example": "Custom 1", "nullable": true }, "custom2": { "description": "Custom 2", "type": "string", "maxLength": 255, "example": "Custom 2", "nullable": true }, "custom3": { "description": "Custom 3", "type": "string", "maxLength": 255, "example": "Custom 3", "nullable": true }, "custom4": { "description": "Custom 4", "type": "string", "maxLength": 255, "example": "custom 4", "nullable": true }, "removeObjectTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RemoveObjectTimeEnum" } ] }, "synchronizeSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "passwordHashType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PasswordHashType" } ] }, "certificateFile": { "description": "certificate for google workspace", "type": "string", "maxLength": 8192, "nullable": true }, "certificateKey": { "description": "certificate key for google workspace", "type": "string", "maxLength": 8192, "nullable": true }, "defaultParamAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "defaultParamObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "defaultEndpointDeviceParameters": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "defaultEndpointDeviceType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EndpointType" } ] }, "macAddressAttribute": { "description": "Attribute for mac address synchronization", "type": "string", "maxLength": 255, "nullable": true } }, "type": "object" }, "ViewAuthorizationServerResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "isBuiltIn", "purpose", "dbType", "isDeletedAfterSync", "isSynchroOrganizationUnit", "isDeletedOrganizationUnitAfterSync", "isFollowReferralsOn", "isEditableExternalData", "isSynchroIncrementally", "isGeneratePassword", "isPkiSend", "isPkiAutoGen", "isAutomaticWifiNotify", "isExternalTacacsPassword", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "isBuiltIn": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/AuthorizationServerPurposeEnum" }, "dbType": { "$ref": "#/components/schemas/AuthorizationServerType" }, "dbDriver": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationSeverDbDriverEnum" } ] }, "authenticationServiceId": { "type": "string", "nullable": true }, "importServiceId": { "type": "string", "nullable": true }, "socialPortalType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationServerSocialPortalTypeEnum" } ] }, "radiusAuthType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationServerRadiusAuthTypeEnum" } ] }, "dbName": { "type": "string", "nullable": true }, "bearerToken": { "type": "string", "nullable": true }, "isDeletedAfterSync": { "type": "boolean" }, "isSynchroOrganizationUnit": { "type": "boolean" }, "isDeletedOrganizationUnitAfterSync": { "type": "boolean" }, "ldapCustomFilter": { "type": "string", "nullable": true }, "ldapOrganizationUnitsCustomFilter": { "type": "string", "nullable": true }, "isFollowReferralsOn": { "type": "boolean" }, "baseDn": { "type": "string", "nullable": true }, "loginType": { "type": "string", "nullable": true }, "secondLoginType": { "type": "string", "nullable": true }, "isEditableExternalData": { "type": "boolean" }, "isSynchroIncrementally": { "type": "boolean" }, "isGeneratePassword": { "type": "boolean" }, "isPkiSend": { "type": "boolean" }, "isPkiAutoGen": { "type": "boolean" }, "isAutomaticWifiNotify": { "type": "boolean" }, "isExternalTacacsPassword": { "type": "boolean" }, "defaultEndpointDeviceType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EndpointType" } ] }, "macAddressAttribute": { "type": "string", "nullable": true }, "integrationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIntegrationServerResponse" } ] }, "ldapService": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListLdapServiceResponse" } ] }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" }, "nullable": true }, "defaultParamAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "defaultParamObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "defaultEndpointDeviceParameters": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceHandler" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "synchroInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SynchronizationIntervalEnum" } ] }, "synchronizedAt": { "type": "string", "nullable": true }, "removeObjectTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RemoveObjectTimeEnum" } ] }, "synchronizeSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "certificateFile": { "type": "string", "nullable": true }, "certificateKey": { "type": "string", "nullable": true }, "passwordHashType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PasswordHashType" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "AuthorizationServerSyncRequest": { "properties": { "isFullSync": { "description": "If true, perform a full synchronization; if false, perform an incremental synchronization", "type": "boolean", "default": true, "example": false } }, "type": "object" }, "ViewCreatorTacacsResponse": { "required": [ "passwordMaxLifetime", "passwordMinLifetime", "passwordExpirationLifetime" ], "properties": { "passwordMaxLifetime": { "type": "integer" }, "passwordMinLifetime": { "type": "integer" }, "passwordExpirationLifetime": { "type": "integer" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "CreatorTacacsRequest": { "required": [ "passwordMaxLifetime", "passwordMinLifetime", "passwordExpirationLifetime" ], "properties": { "passwordMaxLifetime": { "description": "Maximum password lifetime", "type": "integer", "maxLength": 255 }, "passwordMinLifetime": { "description": "Maximum password lifetime", "type": "integer", "maxLength": 255 }, "passwordExpirationLifetime": { "description": "Maximum password lifetime", "type": "integer", "maxLength": 255 } }, "type": "object" }, "ViewIntegrationServerResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "apiConfig": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ViewIntegrationServerConfigResponse" } ] }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IntegrationServerType" } ] }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "authorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "IntegrationServerRequest": { "required": [ "name", "isEnabled", "apiConfig" ], "properties": { "name": { "description": "Name of Integration Server", "type": "string", "maxLength": 255 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "Is Integration Server enabled", "type": "boolean", "example": true }, "apiConfig": { "$ref": "#/components/schemas/IntegrationServerConfigRequest" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "LdapServiceRequest": { "required": [ "name", "mainRealm", "mainDomain", "controllers", "isEnabled", "dnsIps", "isDefault", "isReferral" ], "properties": { "name": { "description": "Name of LDAP service", "type": "string", "example": "string" }, "mainRealm": { "description": "Main realm of LDAP service", "type": "string", "example": "string" }, "realms": { "description": "realms of LDAP service", "type": "array", "items": { "type": "string" }, "example": [ "nv1.local", "nv2.local", "nv3.local" ], "nullable": true }, "mainDomain": { "description": "Main domain of LDAP service", "type": "string", "example": [ "nacview.com" ] }, "domains": { "description": "Domains of LDAP service", "type": "array", "items": { "type": "string" }, "example": [ "nv.nacview.com", "nv1.nacview.com", "nv2.nacview.com" ], "nullable": true }, "controllers": { "description": "Controllers of LDAP service", "type": "array", "items": { "type": "string" }, "example": [ "nv.nacview" ] }, "isEnabled": { "description": "is LDAP service enabled", "type": "boolean", "example": true }, "dnsIps": { "description": "dns ip of LDAP service", "type": "array", "items": { "type": "string" }, "example": [ "10.10.60.20", "10.10.60.21" ] }, "isDefault": { "description": "is default of LDAP service", "type": "boolean", "example": true }, "description": { "description": "description of LDAP service", "type": "string", "maxLength": 4096, "example": "string", "nullable": true }, "isReferral": { "description": "is referral of LDAP service", "type": "boolean", "example": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewLdapServiceResponse": { "required": [ "id", "name", "mainRealm", "mainDomain", "isEnabled", "isDefault", "isReferral", "dnsIps", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "mainRealm": { "type": "string" }, "mainDomain": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isReferral": { "type": "boolean" }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "controllers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "realms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "domains": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dnsIps": { "type": "array", "items": { "type": "string" } }, "ldapServiceReferrals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListLdapServiceReferralResponse" }, "nullable": true }, "systemNodeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListLdapServiceSystemNodeParameterResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "LdapServiceReferralRequest": { "required": [ "name", "mainRealm", "isEnabled" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "description": { "description": "Description of TACACS server", "type": "string", "maxLength": 4096, "example": "string", "nullable": true }, "mainRealm": { "type": "string", "maxLength": 1024 }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ViewLdapServiceReferralResponse": { "required": [ "id", "name", "isEnabled", "mainRealm", "ldapService", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "mainRealm": { "type": "string" }, "ldapService": { "$ref": "#/components/schemas/MiniListLdapServiceResponse" }, "createdBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "NewLdapServiceSystemNodeParameterRequest": { "required": [ "ldapService", "systemNode", "name", "isEnabled", "controllers", "dnsIps" ], "properties": { "ldapService": { "$ref": "#/components/schemas/NestedIdentifier" }, "systemNode": { "$ref": "#/components/schemas/NestedIdentifier" }, "name": { "type": "string", "maxLength": 255 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "type": "boolean", "example": true }, "controllers": { "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "dnsIps": { "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewLdapServiceSystemNodeParameterResponse": { "required": [ "id", "name", "isEnabled", "ldapService", "systemNode", "controllers", "dnsIps", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "ldapService": { "$ref": "#/components/schemas/MiniListLdapServiceResponse" }, "systemNode": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "controllers": { "type": "array", "items": { "type": "string" } }, "dnsIps": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditLdapServiceSystemNodeParameterRequest": { "required": [ "name", "isEnabled", "controllers", "dnsIps" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "type": "boolean", "example": true }, "controllers": { "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "dnsIps": { "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ObjectGroupExternalIdentifierRequest": { "required": [ "objectGroup", "name", "isEnabled" ], "properties": { "objectGroup": { "$ref": "#/components/schemas/NestedIdentifier" }, "name": { "description": "External group identifier", "type": "string", "maxLength": 1024, "minLength": 1 }, "isEnabled": { "description": "is ObjectGroup service enabled", "type": "boolean", "example": true } }, "type": "object" }, "ViewObjectGroupExternalIdentifierResponse": { "required": [ "id", "name", "authorizationServer", "objectGroup", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "objectGroup": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "TacacsServerRequest": { "required": [ "name", "isEnabled", "priorityType", "isOtpEnabled" ], "properties": { "name": { "description": "Name of TACACS server", "type": "string", "maxLength": 255, "minLength": 2, "example": "string" }, "privLevel": { "description": "Name of TACACS server", "type": "integer", "default": 15, "maximum": 15, "minimum": 1, "example": 15 }, "description": { "description": "description of TACACS server", "type": "string", "maxLength": 4096, "example": "string", "nullable": true }, "junosExec": { "description": "junosExec of TACACS server", "type": "string", "maxLength": 255, "minLength": 1, "example": "string", "nullable": true }, "isEnabled": { "description": "is LDAP service enabled", "type": "boolean", "example": true }, "priorityType": { "$ref": "#/components/schemas/PriorityType" }, "isOtpEnabled": { "description": "is OTP enabled", "type": "boolean", "example": true }, "otpType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OtpType" } ] }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "userAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "deviceCredentials": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewTacacsServerResponse": { "required": [ "id", "name", "isEnabled", "priorityType", "privLevel", "createdAt", "isOtpEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "priorityType": { "$ref": "#/components/schemas/PriorityType" }, "privLevel": { "type": "integer" }, "junosExec": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListUserResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "tacacsServerSettings": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListTacacsServerSettingsResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "userAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "deviceCredentials": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" }, "nullable": true }, "customParameters": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListTacacsServerCustomParameterResponse" }, "nullable": true }, "isOtpEnabled": { "type": "boolean" }, "otpType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OtpType" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "TacacsServerCustomParameterRequest": { "required": [ "name", "value", "isEnabled", "purpose" ], "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1 }, "description": { "description": "Description of TACACS server", "type": "string", "maxLength": 4096, "example": "string", "nullable": true }, "service": { "type": "string", "maxLength": 1024, "nullable": true }, "value": { "type": "string", "maxLength": 1024 }, "isEnabled": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/TacacsServerCustomParameterPurpose" } }, "type": "object" }, "ViewTacacsServerCustomParameterResponse": { "required": [ "id", "name", "isEnabled", "value", "purpose", "createdAt", "tacacsServer", "accessType" ], "properties": { "id": { "type": "integer" }, "description": { "type": "string", "nullable": true }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "value": { "type": "string" }, "service": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/TacacsServerCustomParameterPurpose" }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "tacacsServer": { "$ref": "#/components/schemas/MiniListTacacsServerResponse" }, "accessType": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "TacacsServerSettingsRequest": { "required": [ "name", "command", "isEnabled", "priorityType" ], "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1 }, "description": { "description": "Description of TACACS server", "type": "string", "maxLength": 4096, "example": "string", "nullable": true }, "command": { "type": "string", "maxLength": 4096 }, "isEnabled": { "type": "boolean" }, "priorityType": { "$ref": "#/components/schemas/PriorityType" } }, "type": "object" }, "ViewTacacsServerSettingsResponse": { "required": [ "id", "command", "name", "isEnabled", "createdAt", "tacacsServer", "priorityType", "accessType" ], "properties": { "id": { "type": "integer" }, "command": { "type": "string" }, "description": { "type": "string", "nullable": true }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "tacacsServer": { "$ref": "#/components/schemas/MiniListTacacsServerResponse" }, "priorityType": { "$ref": "#/components/schemas/PriorityType" }, "accessType": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "ListAccessGroupExternalIdentifierResponse": { "required": [ "id", "name", "authorizationServer", "accessGroup", "isEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "accessGroup": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListAccessGroupExternalIdentifierResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListAuthorizationServerResponse": { "required": [ "id", "name", "isEnabled", "isBuiltIn", "isSynchroIncrementally", "purpose", "dbType", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "isSynchroIncrementally": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/AuthorizationServerPurposeEnum" }, "dbType": { "$ref": "#/components/schemas/AuthorizationServerType" }, "createdAt": { "type": "string", "nullable": true }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "synchroInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SynchronizationIntervalEnum" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListAuthorizationServerResponse": { "required": [ "id", "name", "isEnabled", "purpose", "dbType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/AuthorizationServerPurposeEnum" }, "dbType": { "$ref": "#/components/schemas/AuthorizationServerType" } }, "type": "object" }, "FetchLdapGroupsRequest": { "properties": { "isIncrement": { "description": "Search groups with increment filter", "type": "boolean", "default": false, "example": true } }, "type": "object" }, "FetchLdapGroupsResponse": { "required": [ "cn", "distinguishedName" ], "properties": { "cn": { "type": "string" }, "distinguishedName": { "type": "string" } }, "type": "object" }, "FetchSqlGroupsRequest": { "required": [ "groupType" ], "properties": { "isIncrement": { "description": "Search groups with increment filter", "type": "boolean", "default": false, "example": true }, "groupType": { "$ref": "#/components/schemas/SearchGroupType" } }, "type": "object" }, "FetchSqlGroupsResponse": { "required": [ "relatedObjectIds", "id", "name", "isAccountActive", "whenChanged", "externalIntegrationId" ], "properties": { "relatedObjectIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" }, "isAccountActive": { "type": "boolean" }, "whenChanged": { "type": "string" }, "externalIntegrationId": { "type": "string" } }, "type": "object" }, "FindRootDseRequest": { "required": [ "url" ], "properties": { "url": { "description": "LDAP URL", "type": "string" } }, "type": "object" }, "LdapRootDseResponse": { "required": [ "rootDse" ], "properties": { "rootDse": { "type": "string" } }, "type": "object" }, "FindOrganizationUnitsStructureRequest": { "properties": { "authorizationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "OrganizationUnitsResponse": { "properties": { "units": { "title": "Generated from protobuf field .syncService.OrganizationUnitsResult units = 1;", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganizationUnitsResult" } ] }, "total": { "title": "Generated from protobuf field int32 total = 2;", "type": "integer", "default": 0 } }, "type": "object" }, "FindOrganizationUnitsStructureByCredentialsRequest": { "required": [ "url", "login", "password", "baseDn" ], "properties": { "url": { "description": "LDAP URL", "type": "string" }, "login": { "description": "LDAP login", "type": "string" }, "password": { "description": "LDAP password", "type": "string" }, "baseDn": { "description": "Ldap base dn", "type": "string" } }, "type": "object" }, "FetchRecordByDnRequest": { "required": [ "authorizationServer", "dn" ], "properties": { "authorizationServer": { "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "dn": { "description": "Ldap base dn", "type": "string" } }, "type": "object" }, "RecordByDnResponse": { "properties": { "objectSid": { "title": "Generated from protobuf field string objectSid = 1;", "type": "string", "default": "" }, "distinguishedName": { "title": "Generated from protobuf field string distinguishedName = 2;", "type": "string", "default": "" }, "uid": { "title": "Generated from protobuf field string uid = 3;", "type": "string", "default": "" }, "mail": { "title": "Generated from protobuf field string mail = 4;", "type": "string", "default": "" }, "cn": { "title": "Generated from protobuf field string cn = 5;", "type": "string", "default": "" }, "givenName": { "title": "Generated from protobuf field string givenName = 6;", "type": "string", "default": "" }, "sn": { "title": "Generated from protobuf field string sn = 7;", "type": "string", "default": "" }, "samAccountName": { "title": "Generated from protobuf field string samAccountName = 8;", "type": "string", "default": "" }, "userPrincipalName": { "title": "Generated from protobuf field string userPrincipalName = 9;", "type": "string", "default": "" }, "isAccountActive": { "title": "Generated from protobuf field bool isAccountActive = 10;", "type": "boolean", "default": false }, "memberOf": { "title": "Generated from protobuf field string memberOf = 11;", "type": "string", "default": "" }, "displayName": { "title": "Generated from protobuf field string displayName = 12;", "type": "string", "default": "" }, "mobile": { "title": "Generated from protobuf field string mobile = 13;", "type": "string", "default": "" }, "description": { "title": "Generated from protobuf field string description = 14;", "type": "string", "default": "" }, "custom1": { "title": "Generated from protobuf field string custom1 = 15;", "type": "string", "default": "" }, "custom2": { "title": "Generated from protobuf field string custom2 = 16;", "type": "string", "default": "" }, "custom3": { "title": "Generated from protobuf field string custom3 = 17;", "type": "string", "default": "" }, "custom4": { "title": "Generated from protobuf field string custom4 = 18;", "type": "string", "default": "" }, "dnsHostName": { "title": "Generated from protobuf field string dnsHostName = 19;", "type": "string", "default": "" }, "operatingSystem": { "title": "Generated from protobuf field string operatingSystem = 20;", "type": "string", "default": "" }, "operatingSystemServicePack": { "title": "Generated from protobuf field string operatingSystemServicePack = 21;", "type": "string", "default": "" }, "operatingSystemVersion": { "title": "Generated from protobuf field string operatingSystemVersion = 22;", "type": "string", "default": "" }, "managedBy": { "title": "Generated from protobuf field string managedBy = 23;", "type": "string", "default": "" }, "msMCSAdmPwd": { "title": "Generated from protobuf field string msMCSAdmPwd = 24;", "type": "string", "default": "" }, "macAddressAttribute": { "title": "Generated from protobuf field string macAddressAttribute = 25;", "type": "string", "default": "" }, "sambaNtPassword": { "title": "Generated from protobuf field string sambaNtPassword = 26;", "type": "string", "default": "" }, "userpassword": { "title": "Generated from protobuf field string userpassword = 27;", "type": "string", "default": "" }, "generationQualifier": { "title": "Generated from protobuf field string generationQualifier = 28;", "type": "string", "default": "" } }, "type": "object" }, "ListIntegrationServerResponse": { "required": [ "id", "name", "isEnabled", "type", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/IntegrationServerType" }, "createdAt": { "type": "string", "nullable": true }, "authorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListIntegrationServerResponse": { "required": [ "id", "name", "isEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/IntegrationServerType" } }, "type": "object" }, "IntegrationServerTestConnectionStatus": { "required": [ "valid" ], "properties": { "message": { "type": "string", "nullable": true }, "valid": { "type": "boolean" } }, "type": "object" }, "ListLdapServiceResponse": { "required": [ "dnsIps", "id", "name", "mainRealm", "mainDomain", "isEnabled", "isDefault", "accessType" ], "properties": { "controllers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "realms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "domains": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dnsIps": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "mainRealm": { "type": "string" }, "mainDomain": { "type": "string" }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "isEnabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "ldapServiceReferrals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListLdapServiceReferralResponse" }, "nullable": true }, "systemNodeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListLdapServiceSystemNodeParameterResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListLdapServiceResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListLdapServiceReferralResponse": { "required": [ "id", "name", "isEnabled", "mainRealm", "ldapService", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "mainRealm": { "type": "string" }, "ldapService": { "$ref": "#/components/schemas/MiniListLdapServiceResponse" }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListLdapServiceReferralResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListLdapServiceSystemNodeParameterResponse": { "required": [ "id", "name", "isEnabled", "ldapService", "systemNode", "controllers", "dnsIps", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "ldapService": { "$ref": "#/components/schemas/MiniListLdapServiceResponse" }, "systemNode": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "controllers": { "type": "array", "items": { "type": "string" } }, "dnsIps": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListLdapServiceSystemNodeParameterResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "ldapService": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListLdapServiceResponse" } ] }, "systemNode": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] } }, "type": "object" }, "ListObjectGroupExternalIdentifierResponse": { "required": [ "id", "name", "authorizationServer", "objectGroups", "isEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "objectGroups": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListObjectGroupExternalIdentifierResponse": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "ListTacacsServerResponse": { "required": [ "accessType", "id", "name", "isEnabled", "privLevel", "isOtpEnabled" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "priorityType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriorityType" } ] }, "privLevel": { "type": "integer" }, "junosExec": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListUserResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "deviceCredentials": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" }, "nullable": true }, "tacacsServerSettings": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListTacacsServerSettingsResponse" }, "nullable": true }, "userAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isOtpEnabled": { "type": "boolean" }, "otpType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OtpType" } ] } }, "type": "object" }, "MiniListTacacsServerResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListTacacsServerCustomParameterResponse": { "required": [ "id", "name", "isEnabled", "value", "purpose", "createdAt", "tacacsServer", "accessType" ], "properties": { "id": { "type": "integer" }, "description": { "type": "string", "nullable": true }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "value": { "type": "string" }, "service": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/TacacsServerCustomParameterPurpose" }, "createdAt": { "type": "string" }, "tacacsServer": { "$ref": "#/components/schemas/MiniListTacacsServerResponse" }, "accessType": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "MiniListTacacsServerCustomParameterResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListTacacsServerSettingsResponse": { "required": [ "id", "command", "name", "isEnabled", "createdAt", "tacacsServer", "priorityType", "accessType" ], "properties": { "id": { "type": "integer" }, "command": { "type": "string" }, "description": { "type": "string", "nullable": true }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string" }, "tacacsServer": { "$ref": "#/components/schemas/MiniListTacacsServerResponse" }, "priorityType": { "$ref": "#/components/schemas/PriorityType" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListTacacsServerSettingsResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ObjectCertificateRequest": { "required": [ "name", "pki" ], "properties": { "name": { "description": "Name of certificate", "type": "string", "maxLength": 255, "example": "string" }, "type": { "$ref": "#/components/schemas/ObjectCertificateType" }, "isEnabled": { "description": "Is certificate active", "type": "boolean", "default": false, "example": true }, "isRevoked": { "description": "Is certificate revoked", "type": "boolean", "default": false, "example": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "pki": { "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "validTo": { "description": "validTo date of certificate", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "validFrom": { "description": "validFrom date of certificate", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true } }, "type": "object" }, "ViewObjectCertificateResponse": { "required": [ "id", "name", "type", "isEnabled", "isCreated", "isRevoked", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ObjectCertificateType" }, "isEnabled": { "type": "boolean" }, "isCreated": { "type": "boolean" }, "isRevoked": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" } ] }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewExternalPkiResponse": { "required": [ "digestAlgorithm", "teapPrimarySchema", "teapSecondarySchema", "eapDefaultSchema", "tlsMinVersion", "tlsMaxVersion", "isOcspEnabled", "isOcspOverrideCertUrl", "isOcspUseNonce", "isOcspSoftfail", "isUploadedKey", "isUploadedServer", "isValidServer", "isValidKey", "isNotifyWhenFailedToDownload", "id", "name", "isDefault", "isEnabled", "isCheckUsernameEnabled", "isScepEnabled", "isWwwMgmt", "eapMtu", "createdAt", "isRadSecEnabled", "domains", "accessType" ], "properties": { "digestAlgorithm": { "$ref": "#/components/schemas/CertificateDigestAlgorithmEnum" }, "teapPrimarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "teapSecondarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "eapDefaultSchema": { "$ref": "#/components/schemas/EapMethodTypeEnum" }, "tlsMinVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "tlsMaxVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isOcspEnabled": { "type": "boolean" }, "isOcspOverrideCertUrl": { "type": "boolean" }, "isOcspUseNonce": { "type": "boolean" }, "isOcspSoftfail": { "type": "boolean" }, "isUploadedKey": { "type": "boolean" }, "isUploadedServer": { "type": "boolean" }, "isValidServer": { "type": "boolean" }, "isValidKey": { "type": "boolean" }, "ocspUrl": { "type": "string", "nullable": true }, "ocspTimeout": { "type": "integer", "nullable": true }, "scepUrl": { "type": "string", "nullable": true }, "scepCerts": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isNotifyWhenFailedToDownload": { "type": "boolean" }, "crlDistributionPoints": { "type": "string", "nullable": true }, "ca": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaView" } ] }, "certChain": { "type": "array", "items": { "$ref": "#/components/schemas/CertChainViewResponse" }, "nullable": true }, "serverCa": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ServerCaView" } ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "isCheckUsernameEnabled": { "type": "boolean" }, "isScepEnabled": { "type": "boolean" }, "isWwwMgmt": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "eapMtu": { "type": "integer" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "isRadSecEnabled": { "type": "boolean" }, "domains": { "type": "array", "items": { "type": "string" } }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ExternalCsrPkiRequest": { "required": [ "ocspTimeout", "ocspUrl", "scepUrl", "name", "defaultValidTime", "teapPrimarySchema", "teapSecondarySchema", "eapDefaultSchema", "tlsMinVersion", "tlsMaxVersion", "digestAlgorithm" ], "properties": { "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "isOcspEnabled": { "description": "ocsp enabled", "type": "boolean", "default": false, "example": true }, "isRadSecEnabled": { "description": "isRadSecEnabled enabled", "type": "boolean", "default": false, "example": true }, "isOcspOverrideCertUrl": { "description": "ocsp override cert url", "type": "boolean", "default": false, "example": false }, "isOcspUseNonce": { "description": "ocsp use nonce", "type": "boolean", "default": false, "example": false }, "isOcspSoftfail": { "description": "ocsp soft fail", "type": "boolean", "default": false, "example": false }, "isNotifyWhenFailedToDownload": { "description": "is notify when failed to download", "type": "boolean", "default": false, "example": false }, "ocspTimeout": { "description": "ocsp timeout", "type": "integer", "example": 5 }, "ocspUrl": { "description": "ocsp url", "type": "string", "maxLength": 255, "example": "string" }, "scepUrl": { "description": "scp url", "type": "string", "maxLength": 255, "example": "string" }, "crlDistributionPoints": { "description": "default valid time", "type": "string", "maxLength": 255, "example": "http://crl.cacert.org/revoke.crl", "nullable": true }, "name": { "description": "name of certificate", "type": "string", "maxLength": 255, "example": "nacview.mycompany.local" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isDefault": { "description": "id default", "type": "boolean", "default": false, "example": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "default": false, "example": true }, "isWwwMgmt": { "description": "is www mgmt", "type": "boolean", "default": false, "example": true }, "isIdentityEnabled": { "description": "is Identity enabled", "type": "boolean", "default": false, "example": false }, "isCheckUsernameEnabled": { "description": "is check isCheckUsernameEnabled enabled", "type": "boolean", "default": true, "example": false }, "isScepEnabled": { "description": "is check isScepEnabled enabled", "type": "boolean", "default": false, "example": false }, "defaultValidTime": { "description": "default valid time", "type": "integer", "example": 256 }, "teapPrimarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "teapSecondarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "eapDefaultSchema": { "$ref": "#/components/schemas/EapMethodTypeEnum" }, "tlsMinVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "tlsMaxVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "digestAlgorithm": { "$ref": "#/components/schemas/CertificateDigestAlgorithmEnum" }, "eapMtu": { "description": "EAP Maximum Transmission Unit of PKI", "type": "integer", "default": 1024, "maximum": 20000, "minimum": 64, "example": 1024 }, "domains": { "description": "Domains of PKI", "type": "array", "items": { "type": "string" }, "example": [ "nv.nacview.com", "nv1.nacview.com", "nv2.nacview.com" ], "nullable": true } }, "type": "object" }, "ServerCaRequest": { "required": [ "name", "countryCode", "stateName", "localityName", "organizationName", "organizationalUnitName", "email", "subjectAlternativeName" ], "properties": { "name": { "description": "name of certificate", "type": "string", "maxLength": 255, "example": "pki ca" }, "countryCode": { "description": "country code", "type": "string", "maxLength": 2, "example": "PL" }, "stateName": { "description": "state name", "type": "string", "maxLength": 255, "example": "silesia" }, "localityName": { "description": "locality name", "type": "string", "maxLength": 255, "example": "warsaw" }, "organizationName": { "description": "organization name", "type": "string", "maxLength": 64, "example": "nacview" }, "organizationalUnitName": { "description": "organizational unit name", "type": "string", "maxLength": 255, "example": "string" }, "email": { "description": "email", "type": "string", "maxLength": 255, "example": "admin@nacview.com" }, "subjectAlternativeName": { "description": "subject alternative name", "type": "array", "items": { "type": "string" }, "example": [ "DNS.1 = 10.10.0.1", "DNS.2 = 10.10.0.2" ] } }, "type": "object" }, "ExternalPkiRequest": { "required": [ "ocspTimeout", "ocspUrl", "scepUrl", "name", "defaultValidTime", "teapPrimarySchema", "teapSecondarySchema", "eapDefaultSchema", "tlsMinVersion", "tlsMaxVersion", "digestAlgorithm" ], "properties": { "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "isOcspEnabled": { "description": "ocsp enabled", "type": "boolean", "default": false, "example": true }, "isRadSecEnabled": { "description": "isRadSecEnabled enabled", "type": "boolean", "default": false, "example": true }, "isOcspOverrideCertUrl": { "description": "ocsp override cert url", "type": "boolean", "default": false, "example": false }, "isOcspUseNonce": { "description": "ocsp use nonce", "type": "boolean", "default": false, "example": false }, "isOcspSoftfail": { "description": "ocsp soft fail", "type": "boolean", "default": false, "example": false }, "isNotifyWhenFailedToDownload": { "description": "is notify when failed to download", "type": "boolean", "default": false, "example": false }, "ocspTimeout": { "description": "ocsp timeout", "type": "integer", "example": 5 }, "ocspUrl": { "description": "ocsp url", "type": "string", "maxLength": 255, "example": "string" }, "scepUrl": { "description": "scp url", "type": "string", "maxLength": 255, "example": "string" }, "crlDistributionPoints": { "description": "default valid time", "type": "string", "maxLength": 255, "example": "http://crl.cacert.org/revoke.crl", "nullable": true }, "name": { "description": "name of certificate", "type": "string", "maxLength": 255, "example": "nacview.mycompany.local" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isDefault": { "description": "id default", "type": "boolean", "default": false, "example": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "default": false, "example": true }, "isWwwMgmt": { "description": "is www mgmt", "type": "boolean", "default": false, "example": true }, "isIdentityEnabled": { "description": "is Identity enabled", "type": "boolean", "default": false, "example": false }, "isCheckUsernameEnabled": { "description": "is check isCheckUsernameEnabled enabled", "type": "boolean", "default": true, "example": false }, "isScepEnabled": { "description": "is check isScepEnabled enabled", "type": "boolean", "default": false, "example": false }, "defaultValidTime": { "description": "default valid time", "type": "integer", "example": 256 }, "teapPrimarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "teapSecondarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "eapDefaultSchema": { "$ref": "#/components/schemas/EapMethodTypeEnum" }, "tlsMinVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "tlsMaxVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "digestAlgorithm": { "$ref": "#/components/schemas/CertificateDigestAlgorithmEnum" }, "eapMtu": { "description": "EAP Maximum Transmission Unit of PKI", "type": "integer", "default": 1024, "maximum": 20000, "minimum": 64, "example": 1024 }, "domains": { "description": "Domains of PKI", "type": "array", "items": { "type": "string" }, "example": [ "nv.nacview.com", "nv1.nacview.com", "nv2.nacview.com" ], "nullable": true } }, "type": "object" }, "InternalCaRequest": { "required": [ "name", "validTo", "countryCode", "stateName", "locationName", "organizationName", "organizationalUnitName", "email" ], "properties": { "name": { "description": "name of certificate", "type": "string", "maxLength": 255, "example": "pki ca" }, "validTo": { "description": "valid to", "type": "string", "example": "2021-12-31T23:59:59Z" }, "countryCode": { "description": "country code", "type": "string", "example": "PL" }, "stateName": { "description": "state name", "type": "string", "maxLength": 255, "example": "silesia" }, "locationName": { "description": "locality name", "type": "string", "maxLength": 255, "example": "warsaw" }, "organizationName": { "description": "organization name", "type": "string", "maxLength": 255, "example": "nacview" }, "organizationalUnitName": { "description": "organizational unit name", "type": "string", "maxLength": 255, "example": "string" }, "email": { "description": "email", "type": "string", "maxLength": 255, "example": "admin@nacview.com" } }, "type": "object" }, "ServerRequest": { "required": [ "name", "validTo", "subjectAlternativeName" ], "properties": { "name": { "description": "name of certificate", "type": "string", "maxLength": 255, "example": "pki ca" }, "validTo": { "description": "valid to", "type": "string", "example": "2021-12-31 23:59:59" }, "subjectAlternativeName": { "description": "subject alternative name", "type": "array", "items": { "type": "string" }, "example": [ "altname1", "altname2" ] } }, "type": "object" }, "ViewInternalPkiResponse": { "required": [ "digestAlgorithm", "teapPrimarySchema", "teapSecondarySchema", "eapDefaultSchema", "tlsMinVersion", "tlsMaxVersion", "isIdentityEnabled", "isCaGenerated", "isServerGenerated", "isServerGenerateRequired", "isCaGenerateRequired", "tag", "id", "name", "isDefault", "isEnabled", "isCheckUsernameEnabled", "isScepEnabled", "isWwwMgmt", "eapMtu", "createdAt", "isRadSecEnabled", "domains", "accessType" ], "properties": { "defaultValidTime": { "type": "integer", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/CertificateDigestAlgorithmEnum" }, "teapPrimarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "teapSecondarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "eapDefaultSchema": { "$ref": "#/components/schemas/EapMethodTypeEnum" }, "tlsMinVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "tlsMaxVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "crlIntervalDuration": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CrlIntervalDuration" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "ca": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaView2" } ] }, "serverCa": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ServerCaView2" } ] }, "isIdentityEnabled": { "type": "boolean" }, "isCaGenerated": { "type": "boolean" }, "isServerGenerated": { "type": "boolean" }, "isServerGenerateRequired": { "type": "boolean" }, "isCaGenerateRequired": { "type": "boolean" }, "certChain": { "type": "array", "items": { "$ref": "#/components/schemas/CertChainViewResponse" }, "nullable": true }, "tag": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "isCheckUsernameEnabled": { "type": "boolean" }, "isScepEnabled": { "type": "boolean" }, "isWwwMgmt": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "eapMtu": { "type": "integer" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "isRadSecEnabled": { "type": "boolean" }, "domains": { "type": "array", "items": { "type": "string" } }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditPkiRequest": { "required": [ "name", "defaultValidTime", "teapPrimarySchema", "teapSecondarySchema", "eapDefaultSchema", "tlsMinVersion", "tlsMaxVersion", "digestAlgorithm" ], "properties": { "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "crlIntervalDuration": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CrlIntervalDuration" } ] }, "isRadSecEnabled": { "description": "isRadSecEnabled enabled", "type": "boolean", "default": false, "example": true }, "name": { "description": "name of certificate", "type": "string", "maxLength": 255, "example": "nacview.mycompany.local" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isDefault": { "description": "id default", "type": "boolean", "default": false, "example": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "default": false, "example": true }, "isWwwMgmt": { "description": "is www mgmt", "type": "boolean", "default": false, "example": true }, "isIdentityEnabled": { "description": "is Identity enabled", "type": "boolean", "default": false, "example": false }, "isCheckUsernameEnabled": { "description": "is check isCheckUsernameEnabled enabled", "type": "boolean", "default": true, "example": false }, "isScepEnabled": { "description": "is check isScepEnabled enabled", "type": "boolean", "default": false, "example": false }, "defaultValidTime": { "description": "default valid time", "type": "integer", "example": 256 }, "teapPrimarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "teapSecondarySchema": { "$ref": "#/components/schemas/TeapMethodTypeEnum" }, "eapDefaultSchema": { "$ref": "#/components/schemas/EapMethodTypeEnum" }, "tlsMinVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "tlsMaxVersion": { "$ref": "#/components/schemas/PkiTlsVersionEnum" }, "digestAlgorithm": { "$ref": "#/components/schemas/CertificateDigestAlgorithmEnum" }, "eapMtu": { "description": "EAP Maximum Transmission Unit of PKI", "type": "integer", "default": 1024, "maximum": 20000, "minimum": 64, "example": 1024 }, "domains": { "description": "Domains of PKI", "type": "array", "items": { "type": "string" }, "example": [ "nv.nacview.com", "nv1.nacview.com", "nv2.nacview.com" ], "nullable": true } }, "type": "object" }, "InternalGenerateCertificateRequest": { "properties": { "generateOnlyServerCertificate": { "description": "Generate only server certificate", "type": "boolean", "default": false, "example": false }, "generateServerAndCaCertificate": { "description": "generate both CA and server certificate", "type": "boolean", "default": false, "example": false } }, "type": "object" }, "AbstractBasicPkiRequest": { "required": [ "name", "type" ], "properties": { "name": { "description": "name of certificate", "type": "string", "maxLength": 255, "example": "pki ca" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "default": false, "example": true }, "type": { "$ref": "#/components/schemas/CertificateTypeEnum" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "isRadSecEnabled": { "description": "isRadSecEnabled enabled", "type": "boolean", "default": false, "example": true } }, "type": "object" }, "ListObjectCertificateResponse": { "required": [ "id", "name", "type", "isEnabled", "isCreated", "isRevoked", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ObjectCertificateType" }, "isEnabled": { "type": "boolean" }, "isCreated": { "type": "boolean" }, "isRevoked": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" } ] }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListObjectCertificateResponse": { "required": [ "id", "name", "isEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/ObjectCertificateType" } }, "type": "object" }, "GeneratedCertificateResponse": { "properties": { "certificateSingingRequest": { "type": "string", "nullable": true } }, "type": "object" }, "ViewInternalCrlResponse": { "required": [ "crlData" ], "properties": { "crlData": { "type": "string" } }, "type": "object" }, "ListPkiResponse": { "required": [ "id", "name", "type", "isWwwMgmt", "isEnabled", "isDefault", "createdAt", "isCaGenerateRequired", "isServerGenerateRequired", "isCaGenerated", "isServerGenerated", "isValidKey", "isValidServer", "isUploadedKey", "isUploadedServer", "domains", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/CertificateTypeEnum" }, "isWwwMgmt": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isCaGenerateRequired": { "type": "boolean" }, "isServerGenerateRequired": { "type": "boolean" }, "isCaGenerated": { "type": "boolean" }, "isServerGenerated": { "type": "boolean" }, "isValidKey": { "type": "boolean" }, "isValidServer": { "type": "boolean" }, "isUploadedKey": { "type": "boolean" }, "isUploadedServer": { "type": "boolean" }, "ca": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaView3" } ] }, "certChain": { "type": "array", "items": { "$ref": "#/components/schemas/CertChainViewResponse" }, "nullable": true }, "server": { "nullable": true, "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ServerCaView3" } ] }, { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/InternalServerView" } ] } ] }, "request": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RequestView" } ] }, "domains": { "type": "array", "items": { "type": "string" } }, "tag": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListPkiResponse": { "required": [ "id", "name", "isEnabled", "isScepEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isScepEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/CertificateTypeEnum" } }, "type": "object" }, "ViewCaPkiResponse": { "properties": { "certificate": { "type": "string", "nullable": true } }, "type": "object" }, "ViewPublicServerCertificatePkiResponse": { "properties": { "certificate": { "type": "string", "nullable": true } }, "type": "object" }, "ViewChainCertificatePkiResponse": { "properties": { "certificate": { "type": "string", "nullable": true }, "organizationUnit": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "ListImportContextResponse": { "required": [ "id", "uuid", "status", "importType", "validationStatus", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "status": { "$ref": "#/components/schemas/ImportStatus" }, "importType": { "$ref": "#/components/schemas/ImportObjectType" }, "validationStatus": { "$ref": "#/components/schemas/ValidationStatusEnum" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewImportContextResponse": { "required": [ "id", "uuid", "importType", "status", "validationStatus", "validationResult", "createdAt" ], "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "importType": { "$ref": "#/components/schemas/ImportObjectType" }, "status": { "$ref": "#/components/schemas/ImportStatus" }, "validationStatus": { "$ref": "#/components/schemas/ValidationStatusEnum" }, "validationResult": { "type": "array", "items": { "$ref": "#/components/schemas/ImportValidationIssueResponse" } }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "type": "object" }, "ColorIdentifierRequest": { "required": [ "name", "color", "isEnabled" ], "properties": { "name": { "type": "string", "maxLength": 255, "example": "Building A" }, "color": { "description": "Color in hex code ", "type": "string", "maxLength": 7, "minLength": 7, "example": "#11FF00" }, "isEnabled": { "type": "boolean", "example": false }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Second floor vlan", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewColorIdentifierResponse": { "required": [ "id", "name", "color", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListVlanResponse" }, "nullable": true }, "subnetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSubnetworkResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewCreatorEduroamResponse": { "required": [ "isEnabled" ], "properties": { "isEnabled": { "type": "boolean" }, "eduroamPrimaryServer": { "type": "string", "nullable": true }, "eduroamSecondaryServer": { "type": "string", "nullable": true }, "eduroamPrimaryServerPort": { "type": "integer", "nullable": true }, "eduroamSecondaryServerPort": { "type": "integer", "nullable": true }, "eduroamRealm": { "type": "array", "items": { "type": "string" }, "nullable": true }, "eduroamCuiHash": { "type": "string", "nullable": true }, "eduroamCuiOperatorName": { "type": "string", "nullable": true }, "eduroamPrimaryServerSecret": { "type": "string", "nullable": true }, "eduroamSecondaryServerSecret": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "CreatorEduroamRequest": { "required": [ "isEnabled", "eduroamRealm" ], "properties": { "isEnabled": { "description": "Is eduroam enabled.", "type": "boolean", "example": "false" }, "eduroamPrimaryServer": { "description": "Eduroam primary server IP/domain.", "type": "string", "default": "", "example": "eduroam.company.pl" }, "eduroamSecondaryServer": { "description": "Eduroam secondary server IP/domain.", "type": "string", "default": "", "example": "10.10.1.10" }, "eduroamPrimaryServerPort": { "description": "Eduroam primary server port.", "type": "string", "default": 1812, "maximum": 65535, "minimum": 1, "example": "1812", "nullable": true }, "eduroamSecondaryServerPort": { "description": "Eduroam secondary server port.", "type": "string", "default": 1812, "maximum": 65535, "minimum": 1, "example": "1812", "nullable": true }, "eduroamPrimaryServerSecret": { "description": "Eduroam primary server secret.", "type": "string", "default": "", "example": "FY6ExbXjpwUgXiQ1jr9ckD4CMmX1EBCi", "nullable": true }, "eduroamSecondaryServerSecret": { "description": "Eduroam primary server secret.", "type": "string", "default": "", "example": "FY6ExbXjpwUgXiQ1jr9ckD4CMmX1EBCi", "nullable": true }, "eduroamRealm": { "type": "array", "items": { "type": "string" } }, "eduroamCuiHash": { "description": "CUI (Chargeable User Identity) identifier generation for eduroam users", "type": "string", "default": "", "example": "FY6ExbXjpwUgXiQ1jr9ckD4CMmX1EBCi" }, "eduroamCuiOperatorName": { "description": "The name for the operator, this parameter is used for information purposes.", "type": "string", "default": "", "example": "1.domain.company.com" } }, "type": "object" }, "ViewCreatorMonitoringResponse": { "required": [ "isEnabled", "authUsage", "portInputUsage", "portOutputUsage", "monitoringInterval" ], "properties": { "isEnabled": { "type": "boolean" }, "authUsage": { "type": "integer" }, "portInputUsage": { "type": "integer" }, "portOutputUsage": { "type": "integer" }, "monitoringInterval": { "$ref": "#/components/schemas/MonitoringInterval" }, "snmpSecret": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" }, "nullable": true } }, "type": "object" }, "CreatorMonitoringRequest": { "required": [ "isEnabled", "monitoringInterval" ], "properties": { "isEnabled": { "type": "boolean" }, "authUsage": { "type": "integer", "nullable": true }, "portInputUsage": { "type": "integer", "maximum": 100, "exclusiveMaximum": true, "minimum": 0, "exclusiveMinimum": true, "nullable": true }, "portOutputUsage": { "type": "integer", "maximum": 100, "exclusiveMaximum": true, "minimum": 0, "exclusiveMinimum": true, "nullable": true }, "monitoringInterval": { "$ref": "#/components/schemas/MonitoringInterval" }, "snmpSecret": { "type": "string", "maxLength": 255, "nullable": true }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "DhcpOptionRequest": { "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "maxLength": 4096, "nullable": true }, "isEnabled": { "type": "boolean", "default": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewDhcpOptionResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "dhcpOptionItems": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpOptionItemResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "DhcpOptionItemRequest": { "required": [ "name", "isEnabled", "value", "op" ], "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "nullable": true }, "isEnabled": { "type": "boolean" }, "value": { "type": "string", "maxLength": 255, "minLength": 1 }, "op": { "$ref": "#/components/schemas/DhcpOptionOperator" } }, "type": "object" }, "ViewDhcpOptionItemResponse": { "required": [ "id", "name", "isEnabled", "value", "createdAt", "op", "dhcpOption", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "op": { "$ref": "#/components/schemas/DhcpOptionOperator" }, "dhcpOption": { "$ref": "#/components/schemas/MiniListDhcpOptionResponse" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewDhcpWhitelistResponse": { "required": [ "id", "name", "isEnabled", "macAddressObjectGroups", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isEnabled": { "type": "boolean" }, "macAddressObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" } }, "ipAddressObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "DhcpWhitelistRequest": { "required": [ "name", "isEnabled", "macAddressObjectGroups" ], "properties": { "name": { "description": "name of DHCP Whitelist", "type": "string", "maxLength": 255 }, "description": { "description": "description of DHCP Whitelist", "type": "string", "maxLength": 4096, "example": "Some description", "nullable": true }, "isEnabled": { "description": "Is DHCP Whitelist enabled", "type": "boolean" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "macAddressObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" } }, "ipAddressObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewIpAddressResponse": { "required": [ "id", "name", "type", "purpose", "isEnabled", "isUsage", "isDnsCheck", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/IpAddressType" }, "purpose": { "$ref": "#/components/schemas/IpAddressPurpose" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isUsage": { "type": "boolean" }, "isDnsCheck": { "type": "boolean" }, "dns": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "subnetwork": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSubnetworkResponse" } ] }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "macAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMacAddressResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "IpAddressRequest": { "required": [ "purpose", "isEnabled" ], "properties": { "purpose": { "$ref": "#/components/schemas/IpAddressPurpose" }, "description": { "description": "description of IP address", "type": "string", "maxLength": 4096, "example": "Some description", "nullable": true }, "isEnabled": { "description": "Is IP address enabled", "type": "boolean" }, "isDnsCheck": { "type": "boolean", "default": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "RemoveLeaseSubnetworkRequest": { "required": [ "ipAddress", "macAddress" ], "properties": { "ipAddress": { "description": "IP address to be removed", "type": "string", "example": "192.168.0.0" }, "macAddress": { "description": "mac address to be removed", "type": "string", "example": "c1:ba:d2:86:86:29" } }, "type": "object" }, "NewObjectGroupRequest": { "required": [ "name", "purpose", "isEnabled" ], "properties": { "name": { "description": "name of object group", "type": "string", "maxLength": 100, "example": "Group #1" }, "purpose": { "$ref": "#/components/schemas/PurposeObjectGroupTypeEnum" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "type": "boolean", "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewObjectGroupResponse": { "required": [ "id", "name", "isEnabled", "purpose", "type", "isBuiltIn", "createdAt" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/PurposeObjectGroupTypeEnum" }, "type": { "$ref": "#/components/schemas/ObjectGroupType" }, "isBuiltIn": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIdentityResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "macAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMacAddressResponse" }, "nullable": true }, "ports": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDevicePortResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "EditObjectGroupRequest": { "required": [ "name", "isEnabled" ], "properties": { "name": { "description": "name of object group", "type": "string", "maxLength": 100, "example": "Group #1" }, "description": { "description": "description of object group", "type": "string", "maxLength": 255, "example": "test object group description", "nullable": true }, "isEnabled": { "type": "boolean", "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "NewRelationsObjectGroupRequest": { "required": [ "objects", "resource" ], "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" } }, "resource": { "description": "field to set the resource type for the object group relation", "type": "string", "enum": [ "identity", "mac_address", "port", "endpoint_device", "network_device", "ip_address" ], "example": "object_group_ports" } }, "type": "object" }, "RemoveRelationsObjectGroupRequest": { "required": [ "objects", "resource" ], "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" } }, "resource": { "description": "field to set the resource type for the object group relation", "type": "string", "enum": [ "identity", "mac_address", "port", "endpoint_device", "network_device", "ip_address" ], "example": "object_group_ports" } }, "type": "object" }, "ViewNetworkDevicePortResponse": { "required": [ "id", "name", "isEnabled", "purpose", "type", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/PortPurposeEnum" }, "type": { "$ref": "#/components/schemas/PortTypeEnum" }, "snmpName": { "type": "string", "nullable": true }, "telnetName": { "type": "string", "nullable": true }, "radiusName": { "type": "string", "nullable": true }, "trafficInOverloadPercent": { "type": "integer", "nullable": true }, "trafficOutOverloadPercent": { "type": "integer", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "networkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "taggedVlans": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListVlanResponse" }, "nullable": true }, "untaggedVlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "vlanVoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "PortRequest": { "required": [ "name", "isEnabled", "purpose", "type" ], "properties": { "name": { "description": "Name of port", "type": "string", "maxLength": 255, "example": "port 1" }, "description": { "description": "description of port", "type": "string", "maxLength": 4096, "example": "string", "nullable": true }, "isEnabled": { "description": "is port enabled", "type": "boolean", "example": true }, "purpose": { "$ref": "#/components/schemas/PortPurposeEnum" }, "type": { "$ref": "#/components/schemas/PortTypeEnum" }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "taggedVlans": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "untaggedVlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "vlanVoice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "trafficInOverloadPercent": { "description": "traffic in percent", "type": "integer", "maximum": 100, "minimum": 0, "example": 50, "nullable": true }, "trafficOutOverloadPercent": { "description": "traffic out percent", "type": "integer", "maximum": 100, "minimum": 0, "example": 80, "nullable": true }, "snmpName": { "description": "snmp name", "type": "string", "maxLength": 255, "example": "string", "nullable": true }, "telnetName": { "description": "telnet name", "type": "string", "maxLength": 255, "example": "string", "nullable": true }, "radiusName": { "description": "radius name", "type": "string", "maxLength": 255, "example": "string", "nullable": true } }, "type": "object" }, "PrintableTemplateRequest": { "required": [ "name", "actionLabel", "printType", "isTemplateForRightPanel", "isTemplateForSummaryGeneration", "body", "isEnabled", "isTemplateLandscape" ], "properties": { "name": { "description": "Name of printable template", "type": "string", "maxLength": 64, "example": "my printable template" }, "actionLabel": { "description": "Name of action", "type": "string", "maxLength": 255, "example": "PDF card" }, "printType": { "$ref": "#/components/schemas/PrintableTypeEnum" }, "isTemplateForRightPanel": { "description": "Is a panel template", "type": "boolean", "example": "true" }, "isTemplateForSummaryGeneration": { "description": "Is a summary template", "type": "boolean", "example": "true" }, "body": { "description": "Content of template", "type": "string" }, "isEnabled": { "description": "Is enabled", "type": "boolean", "example": "true" }, "isTemplateLandscape": { "description": "Is template landscape oriented", "type": "boolean", "example": "true" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewPrintableTemplateResponse": { "required": [ "id", "name", "actionLabel", "printType", "isTemplateForRightPanel", "isTemplateForSummaryGeneration", "isEnabled", "body", "isTemplateLandscape", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "actionLabel": { "type": "string" }, "printType": { "$ref": "#/components/schemas/PrintableTypeEnum" }, "isTemplateForRightPanel": { "type": "boolean" }, "isTemplateForSummaryGeneration": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "body": { "type": "string" }, "isTemplateLandscape": { "type": "boolean" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "NewSectorRequest": { "required": [ "name", "isEnabled" ], "properties": { "name": { "description": "Name of sector", "type": "string", "maxLength": 255, "example": "sector 1" }, "isEnabled": { "description": "Name of sector", "type": "boolean", "example": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewSectorResponse": { "required": [ "id", "name", "isEnabled", "isBuiltIn", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "monitoringSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "downloadConfigurationSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "profilingSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditSectorRequest": { "required": [ "name", "isEnabled" ], "properties": { "name": { "description": "Name of sector", "type": "string", "maxLength": 255, "example": "sector 1" }, "isEnabled": { "description": "is sector enabled", "type": "boolean", "example": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "monitoringSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "downloadConfigurationSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "NewSubnetworkRequest": { "required": [ "networkIpAddress", "cidr", "name", "isEnabled" ], "properties": { "networkIpAddress": { "description": "IP address", "type": "string", "example": "192.168.0.0" }, "cidr": { "description": "CIDR of subnetwork", "type": "integer", "maximum": 30, "minimum": 16, "example": 24 }, "name": { "description": "name of subnetwork", "type": "string", "maxLength": 100, "example": "Subnet" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "Is subnetwork enabled", "type": "boolean" }, "isDhcpEnabled": { "description": "Is DHCP enabled", "type": "boolean", "default": false }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewSubnetworkResponse": { "required": [ "id", "name", "isEnabled", "cidr", "netmask", "isDhcpEnabled", "isDhcpMonitoring", "dhcpMonitoringOverload", "dhcpMonitoringDeclineOverload", "dhcpStaticLeaseTime", "dhcpDynamicLeaseTime", "isDhcpAutoLink", "isDhcpIgnoreVlanRequest", "trustedDhcpServers", "dhcpUsage", "isArpManaged", "isDnsRefreshEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "cidr": { "type": "integer" }, "netmask": { "type": "string" }, "networkIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "gatewayIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "broadcastIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListVlanResponse" }, "nullable": true }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListColorIdentifierResponse" } ] }, "isDhcpEnabled": { "type": "boolean" }, "isDhcpMonitoring": { "type": "boolean" }, "dhcpMonitoringOverload": { "type": "integer" }, "dhcpMonitoringDeclineOverload": { "type": "integer" }, "dhcpStaticLeaseTime": { "type": "integer" }, "dhcpDynamicLeaseTime": { "type": "integer" }, "primaryDhcpDns": { "type": "string", "nullable": true }, "secondaryDhcpDns": { "type": "string", "nullable": true }, "isDhcpAutoLink": { "type": "boolean" }, "isDhcpIgnoreVlanRequest": { "type": "boolean" }, "dhcpOptions": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpOptionResponse" }, "nullable": true }, "dhcpWhitelists": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpWhitelistResponse" }, "nullable": true }, "dhcpBlacklistObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "trustedDhcpServers": { "type": "array", "items": { "type": "string" } }, "dhcpUsage": { "type": "integer" }, "arpVrName": { "type": "string", "nullable": true }, "isArpManaged": { "type": "boolean" }, "isDnsRefreshEnabled": { "type": "boolean" }, "primaryRoutingNetworkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "secondaryRoutingNetworkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditSubnetworkRequest": { "required": [ "gatewayIpAddress", "name", "isEnabled" ], "properties": { "gatewayIpAddress": { "$ref": "#/components/schemas/NestedIdentifier" }, "isDhcpMonitoring": { "description": "Is DHCP monitoring on", "type": "boolean", "default": false }, "isDnsRefreshEnabled": { "description": "Is DNS refresh enabled", "type": "boolean", "default": false }, "dhcpMonitoringOverload": { "description": "DHCP usage warning level (%)", "type": "integer", "default": 75, "maximum": 100, "minimum": 0, "example": 75 }, "dhcpMonitoringDeclineOverload": { "description": "DHCP decline warning level (%)", "type": "integer", "default": 75, "maximum": 100, "minimum": 0, "example": 75 }, "dhcpStaticLeaseTime": { "description": "DHCP static RemoveLease time in seconds", "type": "integer", "default": 1800, "minimum": 0, "example": 3600 }, "dhcpDynamicLeaseTime": { "description": "DHCP dynamic RemoveLease time in seconds", "type": "integer", "default": 1800, "minimum": 0, "example": 3600 }, "primaryDhcpDns": { "description": "Primary dns server", "type": "string", "maxLength": 15, "example": "8.8.8.8", "nullable": true }, "secondaryDhcpDns": { "description": "Secondary dns server", "type": "string", "maxLength": 15, "example": "0.0.0.0", "nullable": true }, "isDhcpAutoLink": { "description": "Is dhcp auto link enabled", "type": "boolean", "default": false }, "isDhcpIgnoreVlanRequest": { "description": "Is dhcp ignoring vlan requests", "type": "boolean", "default": false }, "dhcpOptions": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "dhcpWhitelists": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "dhcpBlacklistObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "trustedDhcpServers": { "description": "Dhcp servers", "type": "array", "items": { "type": "string" }, "example": [ "10.11.10.1", "10.14.10.8" ], "nullable": true }, "arpVrName": { "description": "ARP VR name", "type": "string", "nullable": true }, "isArpManaged": { "description": "Should we generate input for network devices that support ARP", "type": "boolean", "default": false }, "primaryRoutingNetworkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "secondaryRoutingNetworkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "name": { "description": "name of subnetwork", "type": "string", "maxLength": 100, "example": "Subnet" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "Is subnetwork enabled", "type": "boolean" }, "isDhcpEnabled": { "description": "Is DHCP enabled", "type": "boolean", "default": false }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "NewSubnetworkIpAddressesRequest": { "required": [ "firstIpAddress", "numberOfIps" ], "properties": { "firstIpAddress": { "description": "First Ip Address to generate numberOfIpAddress ips", "type": "string", "example": "192.168.0.0" }, "numberOfIps": { "description": "Number of IpAddresses to generate", "type": "integer", "maximum": 2048, "minimum": 1, "example": 24 } }, "type": "object" }, "MigrateSubnetworkRequest": { "required": [ "networkIpAddress", "name" ], "properties": { "networkIpAddress": { "description": "IP address", "type": "string", "example": "192.168.0.0" }, "name": { "description": "New name for migrated subnetwork", "type": "string", "maxLength": 100, "example": "Subnet 192.168.0.0/28" } }, "type": "object" }, "ResizeSubnetworkRequest": { "required": [ "cidr" ], "properties": { "cidr": { "description": "New CIDR of the subnetwork", "type": "integer", "maximum": 30, "minimum": 16, "example": 24 } }, "type": "object" }, "VlanRequest": { "required": [ "name", "tag", "isEnabled" ], "properties": { "name": { "description": "Name of vlan", "type": "string", "maxLength": 255, "example": "my vlan" }, "tag": { "description": "Tag of vlan", "type": "integer", "maximum": 4096, "minimum": 1, "example": 123 }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "Specifies whether the server can be assigned to objects", "type": "boolean", "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewVlanResponse": { "required": [ "id", "name", "tag", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "tag": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListColorIdentifierResponse" } ] }, "subnetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSubnetworkResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "WifiNetworkRequest": { "required": [ "name", "ssid", "isEnabled" ], "properties": { "name": { "description": "Name of wifi network", "type": "string", "maxLength": 100, "example": "Captive Wifi" }, "ssid": { "description": "SSID of wifi network", "type": "string", "maxLength": 32, "example": "captive-wifi" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Captive Portal is available in this network", "nullable": true }, "isEnabled": { "description": "Specifies wheather the server can be assigned to objects", "type": "boolean", "example": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "ViewWifiNetworkResponse": { "required": [ "id", "name", "ssid", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "ssid": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListColorIdentifierResponse": { "required": [ "id", "name", "color", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "subnetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSubnetworkResponse" }, "nullable": true }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListVlanResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListColorIdentifierResponse": { "required": [ "id", "name", "color", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListDhcpOptionResponse": { "required": [ "id", "name", "isEnabled", "dhcpOptionItems", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "dhcpOptionItems": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpOptionItemResponse" } }, "createdAt": { "type": "string" }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListDhcpOptionResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListDhcpOptionItemResponse": { "required": [ "id", "name", "isEnabled", "value", "createdAt", "op", "dhcpOption", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "op": { "$ref": "#/components/schemas/DhcpOptionOperator" }, "dhcpOption": { "$ref": "#/components/schemas/MiniListDhcpOptionResponse" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListDhcpOptionItemResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "dhcpOption": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListDhcpOptionResponse" } ] } }, "type": "object" }, "ListDhcpWhitelistResponse": { "required": [ "id", "name", "isEnabled", "macAddressObjectGroups", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "isEnabled": { "type": "boolean" }, "macAddressObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" } }, "ipAddressObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListDhcpWhitelistResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListIpAddressResponse": { "required": [ "id", "name", "type", "purpose", "isEnabled", "isUsage", "isDnsCheck", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/IpAddressType" }, "purpose": { "$ref": "#/components/schemas/IpAddressPurpose" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isUsage": { "type": "boolean" }, "isDnsCheck": { "type": "boolean" }, "dns": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "subnetwork": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSubnetworkResponse" } ] }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "macAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMacAddressResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListIpAddressResponse": { "required": [ "id", "name", "isEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "subnetwork": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSubnetworkResponse" } ] }, "type": { "$ref": "#/components/schemas/IpAddressType" } }, "type": "object" }, "ListObjectGroupResponse": { "required": [ "id", "name", "isEnabled", "isBuiltIn", "createdAt", "purpose", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "createdAt": { "type": "string" }, "purpose": { "$ref": "#/components/schemas/PurposeObjectGroupTypeEnum" }, "type": { "$ref": "#/components/schemas/ObjectGroupType" }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIdentityResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "macAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMacAddressResponse" }, "nullable": true }, "ports": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDevicePortResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "MiniListObjectGroupResponse": { "required": [ "id", "name", "isEnabled", "purpose", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/PurposeObjectGroupTypeEnum" }, "type": { "$ref": "#/components/schemas/ObjectGroupType" } }, "type": "object" }, "ListNetworkDevicePortResponse": { "required": [ "id", "name", "isEnabled", "purpose", "type", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/PortPurposeEnum" }, "type": { "$ref": "#/components/schemas/PortTypeEnum" }, "snmpName": { "type": "string", "nullable": true }, "telnetName": { "type": "string", "nullable": true }, "radiusName": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "networkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "taggedVlans": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListVlanResponse" }, "nullable": true }, "untaggedVlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListNetworkDevicePortResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "snmpName": { "type": "string", "nullable": true }, "telnetName": { "type": "string", "nullable": true }, "radiusName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "networkDevice": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] } }, "type": "object" }, "ListPrintableTemplateResponse": { "required": [ "id", "name", "actionLabel", "printType", "isTemplateForRightPanel", "isTemplateForSummaryGeneration", "isEnabled", "isTemplateLandscape", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "actionLabel": { "type": "string" }, "printType": { "$ref": "#/components/schemas/PrintableTypeEnum" }, "isTemplateForRightPanel": { "type": "boolean" }, "isTemplateForSummaryGeneration": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "isTemplateLandscape": { "type": "boolean" }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListPrintableTemplatesResponse": { "required": [ "id", "name", "isEnabled", "printType", "isTemplateLandscape" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "printType": { "$ref": "#/components/schemas/PrintableTypeEnum" }, "isTemplateLandscape": { "type": "boolean" } }, "type": "object" }, "ListSectorResponse": { "required": [ "id", "name", "isEnabled", "isBuiltIn", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "monitoringSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "downloadConfigurationSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListSectorResponse": { "required": [ "id", "name", "isEnabled", "isBuiltIn" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" } }, "type": "object" }, "DhcpUsageResponse": { "required": [ "ip", "mac", "expireTime", "isDynamic" ], "properties": { "ip": { "type": "string" }, "mac": { "type": "string" }, "expireTime": { "type": "string" }, "isDynamic": { "type": "boolean" } }, "type": "object" }, "ListSubnetworkResponse": { "required": [ "id", "name", "isEnabled", "cidr", "netmask", "isDhcpEnabled", "isDhcpMonitoring", "isDhcpAutoLink", "dhcpStaticLeaseTime", "dhcpDynamicLeaseTime", "trustedDhcpServers", "dhcpUsage", "createdAt", "isArpManaged", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "cidr": { "type": "integer" }, "netmask": { "type": "string" }, "networkIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "gatewayIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListVlanResponse" }, "nullable": true }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListColorIdentifierResponse" } ] }, "isDhcpEnabled": { "type": "boolean" }, "isDhcpMonitoring": { "type": "boolean" }, "primaryDhcpDns": { "type": "string", "nullable": true }, "secondaryDhcpDns": { "type": "string", "nullable": true }, "isDhcpAutoLink": { "type": "boolean" }, "dhcpStaticLeaseTime": { "type": "integer" }, "dhcpDynamicLeaseTime": { "type": "integer" }, "dhcpOptions": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpOptionResponse" }, "nullable": true }, "dhcpWhitelists": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDhcpWhitelistResponse" }, "nullable": true }, "dhcpBlacklistObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "trustedDhcpServers": { "type": "array", "items": { "type": "string" } }, "dhcpUsage": { "type": "integer" }, "createdAt": { "type": "string" }, "isArpManaged": { "type": "boolean" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListSubnetworkResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "networkIpAddress": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] } }, "type": "object" }, "ListVlansResponse": { "required": [ "id", "name", "tag", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "tag": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "colorIdentifier": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListColorIdentifierResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "subnetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSubnetworkResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListVlanResponse": { "required": [ "id", "name", "tag", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "tag": { "type": "integer" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListWifiNetworkResponse": { "required": [ "id", "name", "ssid", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "ssid": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListWifiNetworkResponse": { "required": [ "id", "name", "ssid", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "ssid": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "CaptivePortalSponsorIdentityActivationRequest": { "required": [ "submitId", "submitHash", "sponsorHash" ], "properties": { "submitId": { "type": "integer" }, "submitHash": { "type": "string" }, "sponsorHash": { "type": "string" }, "identityValidity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalValidity" } ] } }, "type": "object" }, "ViewCaptivePortalResponse": { "required": [ "id", "name", "code", "isEnabled", "isMaster", "isRedirectToHttps", "preferredLocale", "isRequireSponsor", "isManualActivation", "isEndpointDeviceManualActivation", "isPasswordOfTheDay", "isHideRegistrationForm", "isRequireDeviceRegistration", "isDisableNetworkLogin", "isDisableEndpointDeviceConfigurations", "isAutoRegisterDevices", "isDisableNacviewAssistants", "isDisableChangePassword", "isDisableResetPassword", "isDisableOtpInfo", "isHideLogonForm", "isRewriteOldDevices", "isIdentityPersonalDataRequired", "notifyRegisterType", "resetPasswordNotifyType", "defaultValidity", "isCodeAuthorizationEnabled", "codeRefreshType", "isSmsAuthorizationEnabled", "isManifestAuthorizationEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "isMaster": { "type": "boolean" }, "isRedirectToHttps": { "type": "boolean" }, "preferredLocale": { "$ref": "#/components/schemas/CaptivePortalPreferredLocale" }, "urlAddress": { "type": "string", "nullable": true }, "authCacheLifetime": { "type": "integer", "nullable": true }, "openIps": { "type": "array", "items": { "type": "string" }, "nullable": true }, "openAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalSubnetworks": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isRequireSponsor": { "type": "boolean" }, "requireSponsorTime": { "type": "integer", "nullable": true }, "emailLabel": { "type": "string", "nullable": true }, "codeLabel": { "type": "string", "nullable": true }, "isManualActivation": { "type": "boolean" }, "isEndpointDeviceManualActivation": { "type": "boolean" }, "isPasswordOfTheDay": { "type": "boolean" }, "passwordOfTheDayValue": { "type": "string", "nullable": true }, "isHideRegistrationForm": { "type": "boolean" }, "isRequireDeviceRegistration": { "type": "boolean" }, "isDisableNetworkLogin": { "type": "boolean" }, "isDisableEndpointDeviceConfigurations": { "type": "boolean" }, "isAutoRegisterDevices": { "type": "boolean" }, "isDisableNacviewAssistants": { "type": "boolean" }, "isDisableChangePassword": { "type": "boolean" }, "isDisableResetPassword": { "type": "boolean" }, "isDisableOtpInfo": { "type": "boolean" }, "isHideLogonForm": { "type": "boolean" }, "isRewriteOldDevices": { "type": "boolean" }, "isIdentityPersonalDataRequired": { "type": "boolean" }, "authorizationLimit": { "type": "integer", "nullable": true }, "devicesPerUserLimit": { "type": "integer", "nullable": true }, "loginAttemptsLimit": { "type": "integer", "nullable": true }, "otpAppsEnabled": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalVerificationType" } ] }, "mfaType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalVerificationType" } ] }, "notifyRegisterType": { "$ref": "#/components/schemas/CaptivePortalNotifyRegister" }, "resetPasswordNotifyType": { "$ref": "#/components/schemas/CaptivePortalResetPasswordNotify" }, "defaultValidity": { "$ref": "#/components/schemas/CaptivePortalValidity" }, "networkPostAuthRedirect": { "type": "string", "nullable": true }, "postAuthRedirect": { "type": "string", "nullable": true }, "isCodeAuthorizationEnabled": { "type": "boolean" }, "codeRefreshType": { "$ref": "#/components/schemas/CaptivePortalCodeRefresh" }, "isSmsAuthorizationEnabled": { "type": "boolean" }, "isManifestAuthorizationEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "endUserAgreement": { "type": "string", "nullable": true }, "customHeaderTemplate": { "type": "string", "nullable": true }, "customFooterTemplate": { "type": "string", "nullable": true }, "customSuccessMessage": { "type": "string", "nullable": true }, "customFailMessage": { "type": "string", "nullable": true }, "customHeaderAddonTemplate": { "type": "string", "nullable": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "defaultIdentity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "socialAuthorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "nullable": true }, "apiAuthorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "nullable": true }, "nacviewAssistants": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNacviewAssistantResponse" }, "nullable": true }, "registrationForms": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalRegistrationFormResponse" }, "nullable": true }, "captivePortalSponsors": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalSponsorResponse" }, "nullable": true }, "registerObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "CaptivePortalRequest": { "required": [ "name", "preferredLocale", "notifyRegisterType", "resetPasswordNotifyType", "defaultValidity", "codeRefreshType" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "type": "boolean", "default": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "endUserAgreement": { "type": "string", "maxLength": 1024, "nullable": true }, "customHeaderTemplate": { "type": "string", "maxLength": 1024, "nullable": true }, "customFooterTemplate": { "type": "string", "maxLength": 1024, "nullable": true }, "customSuccessMessage": { "type": "string", "maxLength": 1024, "nullable": true }, "customFailMessage": { "type": "string", "maxLength": 1024, "nullable": true }, "customHeaderAddonTemplate": { "type": "string", "maxLength": 1024, "nullable": true }, "isRedirectToHttps": { "type": "boolean", "default": false }, "preferredLocale": { "$ref": "#/components/schemas/CaptivePortalPreferredLocale" }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "urlAddress": { "type": "string", "nullable": true }, "authCacheLifetime": { "type": "integer", "nullable": true }, "openIps": { "description": "open IPS", "type": "array", "items": { "type": "string" }, "example": [ "ip", "ip2" ], "nullable": true }, "openAddresses": { "description": "open addresses", "type": "array", "items": { "type": "string" }, "example": [ "address", "address2" ], "nullable": true }, "externalSubnetworks": { "description": "external subnetworks", "type": "array", "items": { "type": "string" }, "example": [ "subnetwork", "subnetwork2" ], "nullable": true }, "captivePortalSponsors": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "isRequireSponsor": { "type": "boolean", "default": false }, "requireSponsorTime": { "type": "integer", "nullable": true }, "emailLabel": { "type": "string", "maxLength": 255, "nullable": true }, "codeLabel": { "type": "string", "maxLength": 255, "nullable": true }, "isManualActivation": { "type": "boolean", "default": false }, "isEndpointDeviceManualActivation": { "type": "boolean", "default": false }, "isPasswordOfTheDay": { "type": "boolean", "default": false }, "passwordOfTheDayValue": { "type": "string", "maxLength": 255, "minLength": 8, "nullable": true }, "isHideRegistrationForm": { "type": "boolean", "default": false }, "isRequireDeviceRegistration": { "type": "boolean", "default": false }, "isDisableNetworkLogin": { "type": "boolean", "default": false }, "isDisableEndpointDeviceConfigurations": { "type": "boolean", "default": false }, "isDisableChangePassword": { "type": "boolean", "default": false }, "isAutoRegisterDevices": { "type": "boolean", "default": false }, "isDisableNacviewAssistants": { "type": "boolean", "default": false }, "isDisableResetPassword": { "type": "boolean", "default": false }, "isDisableOtpInfo": { "type": "boolean", "default": false }, "isHideLogonForm": { "type": "boolean", "default": false }, "isRewriteOldDevices": { "type": "boolean", "default": false }, "authorizationLimit": { "type": "integer", "nullable": true }, "devicesPerUserLimit": { "type": "integer", "nullable": true }, "loginAttemptsLimit": { "type": "integer", "nullable": true }, "otpAppsEnabled": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalVerificationType" } ] }, "mfaType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalVerificationType" } ] }, "notifyRegisterType": { "$ref": "#/components/schemas/CaptivePortalNotifyRegister" }, "resetPasswordNotifyType": { "$ref": "#/components/schemas/CaptivePortalResetPasswordNotify" }, "defaultValidity": { "$ref": "#/components/schemas/CaptivePortalValidity" }, "networkPostAuthRedirect": { "type": "string", "maxLength": 255, "nullable": true }, "postAuthRedirect": { "type": "string", "maxLength": 255, "nullable": true }, "defaultIdentity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "isCodeAuthorizationEnabled": { "type": "boolean", "default": false }, "codeRefreshType": { "$ref": "#/components/schemas/CaptivePortalCodeRefresh" }, "isSmsAuthorizationEnabled": { "type": "boolean", "default": false }, "isManifestAuthorizationEnabled": { "type": "boolean", "default": false }, "isIdentityPersonalDataRequired": { "type": "boolean", "default": false }, "registerObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "socialAuthorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "apiAuthorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "nacviewAssistants": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "CaptivePortalObjectGroupConfigRequest": { "required": [ "name", "objectGroup" ], "properties": { "name": { "type": "string" }, "isEnabled": { "type": "boolean", "default": true }, "isManualActivation": { "type": "boolean", "default": false }, "isEndpointDeviceManualActivation": { "type": "boolean", "default": false }, "isRequireDeviceRegistration": { "type": "boolean", "default": false }, "isDisableEndpointDeviceConfigurations": { "type": "boolean", "default": false }, "isDisableChangePassword": { "type": "boolean", "default": false }, "isAutoRegisterDevices": { "type": "boolean", "default": false }, "isDisableNetworkLogin": { "type": "boolean", "default": false }, "isDisableNacviewAssistants": { "type": "boolean", "default": false }, "isDisableResetPassword": { "type": "boolean", "default": false }, "isDisableOtpInfo": { "type": "boolean", "default": false }, "isRewriteOldDevices": { "type": "boolean", "default": false }, "authorizationLimit": { "type": "integer", "nullable": true }, "devicesPerUserLimit": { "type": "integer", "nullable": true }, "loginAttemptsLimit": { "type": "integer", "nullable": true }, "objectGroup": { "$ref": "#/components/schemas/NestedIdentifier" }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "mfaType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalVerificationType" } ] } }, "type": "object" }, "ViewCaptivePortalObjectGroupConfigResponse": { "required": [ "id", "name", "isEnabled", "isManualActivation", "isEndpointDeviceManualActivation", "isRequireDeviceRegistration", "isDisableEndpointDeviceConfigurations", "isDisableChangePassword", "isAutoRegisterDevices", "isDisableNetworkLogin", "isDisableNacviewAssistants", "isDisableResetPassword", "isDisableOtpInfo", "isRewriteOldDevices", "objectGroup", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isManualActivation": { "type": "boolean" }, "isEndpointDeviceManualActivation": { "type": "boolean" }, "isRequireDeviceRegistration": { "type": "boolean" }, "isDisableEndpointDeviceConfigurations": { "type": "boolean" }, "isDisableChangePassword": { "type": "boolean" }, "isAutoRegisterDevices": { "type": "boolean" }, "isDisableNetworkLogin": { "type": "boolean" }, "isDisableNacviewAssistants": { "type": "boolean" }, "isDisableResetPassword": { "type": "boolean" }, "isDisableOtpInfo": { "type": "boolean" }, "isRewriteOldDevices": { "type": "boolean" }, "authorizationLimit": { "type": "integer", "nullable": true }, "devicesPerUserLimit": { "type": "integer", "nullable": true }, "loginAttemptsLimit": { "type": "integer", "nullable": true }, "objectGroup": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "mfaType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalVerificationType" } ] }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "CaptivePortalRegistrationFormRequest": { "required": [ "name", "type", "answer" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "isEnabled": { "type": "boolean", "default": false }, "type": { "$ref": "#/components/schemas/CaptivePortalRegistrationFormType" }, "answer": { "type": "string", "maxLength": 255 }, "isRequired": { "type": "boolean", "default": true }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewCaptivePortalRegistrationFormResponse": { "required": [ "id", "name", "isEnabled", "type", "answer", "isRequired", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/CaptivePortalRegistrationFormType" }, "answer": { "type": "string" }, "isRequired": { "type": "boolean" }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "CaptivePortalSponsorRequest": { "required": [ "name", "email", "activateDestinationType" ], "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "type": "boolean", "default": false }, "validFrom": { "description": "valid from", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "validTo": { "description": "valid to", "type": "string", "example": "2022-01-01T00:00:01Z", "nullable": true }, "email": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "maxLength": 255, "nullable": true }, "message": { "type": "string", "maxLength": 255, "nullable": true }, "activateDestinationType": { "$ref": "#/components/schemas/DestinationType" }, "locale": { "$ref": "#/components/schemas/LanguageType" }, "validitySetOnActivation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalValidity" } ] }, "isEmailAsLogin": { "type": "boolean", "default": true }, "loginMinimumLength": { "type": "integer", "default": 1 }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "sponsorObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "registrationObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "registrationAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewCaptivePortalSponsorResponse": { "required": [ "id", "name", "isEnabled", "email", "locale", "activateDestinationType", "isEmailAsLogin", "loginMinimumLength", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "email": { "type": "string" }, "code": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "locale": { "$ref": "#/components/schemas/LanguageType" }, "message": { "type": "string", "nullable": true }, "activateDestinationType": { "$ref": "#/components/schemas/DestinationType" }, "isEmailAsLogin": { "type": "boolean" }, "loginMinimumLength": { "type": "integer" }, "validitySetOnActivation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalValidity" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "sponsorObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "registrationObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "registrationAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewCreatorProfilingResponse": { "required": [ "isEnabled", "isUpdateEndpoint", "isUpdateDbInterval", "updateDbInterval", "modules" ], "properties": { "isEnabled": { "type": "boolean" }, "wmiLogin": { "type": "string", "nullable": true }, "wmiPassword": { "type": "string", "nullable": true }, "winRmLogin": { "type": "string", "nullable": true }, "winRmPassword": { "type": "string", "nullable": true }, "isUpdateEndpoint": { "type": "boolean" }, "isUpdateDbInterval": { "type": "boolean" }, "updateDbInterval": { "$ref": "#/components/schemas/UpdateProfilingDbInterval" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "modules": { "type": "array", "items": { "type": "string" } }, "integrationServers": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIntegrationServerResponse" }, "nullable": true }, "subnetworks": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSubnetworkResponse" }, "nullable": true }, "deviceCredentials": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" }, "nullable": true } }, "type": "object" }, "CreatorProfilingRequest": { "required": [ "isEnabled", "modules", "isUpdateEndpoint", "isUpdateDbInterval", "updateDbInterval" ], "properties": { "isEnabled": { "type": "boolean" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilingModule" } }, "integrationServers": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "subnetworks": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "wmiLogin": { "type": "string", "maxLength": 255, "nullable": true }, "wmiPassword": { "type": "string", "maxLength": 255, "minLength": 8, "nullable": true }, "winRmLogin": { "type": "string", "maxLength": 255, "nullable": true }, "winRmPassword": { "type": "string", "maxLength": 255, "nullable": true }, "deviceCredentials": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "isUpdateEndpoint": { "type": "boolean" }, "isUpdateDbInterval": { "type": "boolean" }, "updateDbInterval": { "$ref": "#/components/schemas/UpdateProfilingDbInterval" } }, "type": "object" }, "NewEndpointDeviceRequest": { "required": [ "authorizationServer", "name" ], "properties": { "authorizationServer": { "$ref": "#/components/schemas/NestedIdentifier" }, "name": { "description": "Endpoint device", "type": "string", "maxLength": 255, "example": "Printer" }, "secondName": { "description": "Second name for Endpoint device", "type": "string", "maxLength": 255, "example": "Printer", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "inventoryNumber": { "description": "Inventory number of Endpoint device", "type": "string", "maxLength": 100, "example": "421", "nullable": true }, "serialNumber": { "description": "Serial number of Endpoint device", "type": "string", "maxLength": 100, "example": "3124-214", "nullable": true }, "custom1": { "description": "Custom 1", "type": "string", "maxLength": 255, "example": "Custom 1", "nullable": true }, "custom2": { "description": "Custom 2", "type": "string", "maxLength": 255, "example": "Custom 2", "nullable": true }, "custom3": { "description": "Custom 3", "type": "string", "maxLength": 255, "example": "Custom 3", "nullable": true }, "custom4": { "description": "Custom 4", "type": "string", "maxLength": 255, "example": "custom 4", "nullable": true }, "isEnabled": { "description": "Endpoint device is activated", "type": "boolean", "default": false, "example": false }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EndpointType" } ] }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "organizationUnit": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "deviceCredentialMonitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "isMonitoring": { "description": "Is monitoring active?", "type": "boolean", "default": false, "example": false } }, "type": "object" }, "ViewEndpointDeviceResponse": { "required": [ "id", "name", "isEnabled", "isOnline", "isAuthValidate", "isScoutModerated", "authorizationServer", "isMonitoring", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "secondName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EndpointType" } ] }, "inventoryNumber": { "type": "string", "nullable": true }, "laps": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isOnline": { "type": "boolean" }, "isAuthValidate": { "type": "boolean" }, "isScoutModerated": { "type": "boolean" }, "scoutUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "scoutApiUser": { "type": "string", "nullable": true }, "scoutApiToken": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "externalIntegrationId": { "type": "string", "nullable": true }, "externalIntegrationUid": { "type": "string", "nullable": true }, "scoutStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ScoutStatus" } ] }, "scoutOs": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ScoutOs" } ] }, "scoutRight": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ScoutRight" } ] }, "organizationUnit": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" } ] }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "monitoring": { "type": "array", "items": {}, "nullable": true }, "profiling": { "type": "array", "items": {}, "nullable": true }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceParameterResponse" }, "nullable": true }, "macAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMacAddressResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "deviceCredentialMonitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" } ] }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSectorResponse" } ] }, "isMonitoring": { "type": "boolean" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditEndpointDeviceRequest": { "required": [ "name" ], "properties": { "name": { "description": "Endpoint device", "type": "string", "maxLength": 255, "example": "Printer" }, "secondName": { "description": "Second name for Endpoint device", "type": "string", "maxLength": 255, "example": "Printer", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "inventoryNumber": { "description": "Inventory number of Endpoint device", "type": "string", "maxLength": 100, "example": "421", "nullable": true }, "serialNumber": { "description": "Serial number of Endpoint device", "type": "string", "maxLength": 100, "example": "3124-214", "nullable": true }, "custom1": { "description": "Custom 1", "type": "string", "maxLength": 255, "example": "Custom 1", "nullable": true }, "custom2": { "description": "Custom 2", "type": "string", "maxLength": 255, "example": "Custom 2", "nullable": true }, "custom3": { "description": "Custom 3", "type": "string", "maxLength": 255, "example": "Custom 3", "nullable": true }, "custom4": { "description": "Custom 4", "type": "string", "maxLength": 255, "example": "custom 4", "nullable": true }, "isEnabled": { "description": "Endpoint device is activated", "type": "boolean", "default": false, "example": false }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EndpointType" } ] }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "organizationUnit": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "deviceCredentialMonitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "isMonitoring": { "description": "Is monitoring active?", "type": "boolean", "default": false, "example": false } }, "type": "object" }, "ViewIdentitiesConfigurationResponse": { "required": [ "defaultPrefix", "nameSchema" ], "properties": { "defaultPrefix": { "type": "string" }, "nameSchema": { "$ref": "#/components/schemas/IdentitySchema" }, "validationInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IdentityValidationInterval" } ] }, "voucherCleanInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VoucherCleanInterval" } ] }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "IdentitiesConfigurationRequest": { "required": [ "defaultPrefix", "nameSchema" ], "properties": { "defaultPrefix": { "type": "string", "maxLength": 255 }, "nameSchema": { "$ref": "#/components/schemas/IdentitySchema" }, "validationInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IdentityValidationInterval" } ] }, "voucherCleanInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VoucherCleanInterval" } ] } }, "type": "object" }, "ChangeIdentityPasswordRequest": { "required": [ "oldPassword", "newPassword" ], "properties": { "oldPassword": { "description": "old password", "type": "string", "maxLength": 255, "example": "Nice-old-p4ssw0rd" }, "newPassword": { "description": "new password", "type": "string", "maxLength": 255, "minLength": 8, "example": "Nice-new-p4ssw0rd" } }, "type": "object" }, "IdentityRefreshMfaRequest": { "properties": { "refreshNacviewSecret": { "description": "flag to refresh nacview secret", "type": "boolean", "default": false, "example": true }, "refreshGoogleSecret": { "description": "flag to refresh google authenticator secret", "type": "boolean", "default": false, "example": true } }, "type": "object" }, "NewIdentityRequest": { "required": [ "authorizationServer" ], "properties": { "authorizationServer": { "$ref": "#/components/schemas/NestedIdentifier" }, "login": { "description": "Login of the Identity", "type": "string", "maxLength": 255, "example": "johndoe", "nullable": true }, "firstName": { "description": "Name of the Identity", "type": "string", "maxLength": 255, "example": "John", "nullable": true }, "secondName": { "description": "Second name of the Identity", "type": "string", "maxLength": 255, "example": "Doe", "nullable": true }, "surname": { "description": "Surname of the Identity", "type": "string", "maxLength": 255, "example": "Smith", "nullable": true }, "email": { "description": "Email of the Identity", "type": "string", "maxLength": 255, "example": "john.doe@example.com", "nullable": true }, "telephoneNumber": { "description": "Telephone number of the Identity", "type": "string", "maxLength": 20, "example": "123456789", "nullable": true }, "secondLogin": { "description": "Second login of the Identity", "type": "string", "maxLength": 255, "example": "johnny", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "Identity is enabled", "type": "boolean", "default": false, "example": true }, "identificationDocument": { "description": "Identification document of the Identity", "type": "string", "maxLength": 255, "example": "ID12345", "nullable": true }, "contactData": { "description": "Contact data of the Identity", "type": "string", "maxLength": 255, "example": "123 Street", "nullable": true }, "password": { "description": "Password of the Identity", "type": "string", "maxLength": 255, "minLength": 8, "example": "Password123", "nullable": true }, "validFrom": { "description": "Valid from date", "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00Z", "nullable": true }, "validTo": { "description": "Valid to date", "type": "string", "format": "date-time", "example": "2023-12-31T23:59:59Z", "nullable": true }, "voucherType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IdentityVoucherType" } ] }, "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "custom1": { "description": "Custom 1", "type": "string", "maxLength": 255, "example": "Custom 1", "nullable": true }, "custom2": { "description": "Custom 2", "type": "string", "maxLength": 255, "example": "Custom 2", "nullable": true }, "custom3": { "description": "Custom 3", "type": "string", "maxLength": 255, "example": "Custom 3", "nullable": true }, "custom4": { "description": "Custom 4", "type": "string", "maxLength": 255, "example": "Custom 4", "nullable": true }, "yubiToken": { "description": "Yubi Token", "type": "string", "maxLength": 45, "minLength": 12, "example": "JBSWY3DPEHPK3PXP ", "nullable": true } }, "type": "object" }, "IdentityCommonMultiCreateRequest": { "required": [ "quantity", "validFrom", "validTo", "prefix" ], "properties": { "quantity": { "description": "Quantity to create an identity", "type": "integer", "maximum": 5000, "minimum": 1, "example": 230 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "validFrom": { "description": "Valid from date", "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00Z" }, "validTo": { "description": "Valid to date", "type": "string", "format": "date-time", "example": "2023-12-31T23:59:59Z" }, "prefix": { "description": "Prefix to create identity", "type": "string", "maxLength": 100, "example": "aot" }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewIdentityResponse": { "required": [ "id", "isEnabled", "login", "nacviewSecret", "googleSecret", "type", "failedLoginAttempts", "authorizationServer", "accessType" ], "properties": { "id": { "type": "integer" }, "firstName": { "type": "string", "nullable": true }, "secondName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "telephoneNumber": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "identificationDocument": { "type": "string", "nullable": true }, "contactData": { "type": "string", "nullable": true }, "login": { "type": "string" }, "secondLogin": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "nacviewSecret": { "type": "string" }, "googleSecret": { "type": "string" }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "maxConcurrentDevices": { "type": "integer", "nullable": true }, "externalIntegrationId": { "type": "string", "nullable": true }, "externalIntegrationUid": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/IdentityType" }, "voucherType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IdentityVoucherType" } ] }, "failedLoginAttempts": { "type": "integer" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "yubiToken": { "type": "string", "nullable": true }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditIdentityRequest": { "required": [ "login" ], "properties": { "login": { "description": "Login of the Identity", "type": "string", "maxLength": 255, "example": "johndoe" }, "firstName": { "description": "Name of the Identity", "type": "string", "maxLength": 255, "example": "John", "nullable": true }, "secondName": { "description": "Second name of the Identity", "type": "string", "maxLength": 255, "example": "Doe", "nullable": true }, "surname": { "description": "Surname of the Identity", "type": "string", "maxLength": 255, "example": "Smith", "nullable": true }, "email": { "description": "Email of the Identity", "type": "string", "maxLength": 255, "example": "john.doe@example.com", "nullable": true }, "telephoneNumber": { "description": "Telephone number of the Identity", "type": "string", "maxLength": 20, "example": "123456789", "nullable": true }, "secondLogin": { "description": "Second login of the Identity", "type": "string", "maxLength": 255, "example": "johnny", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "Identity is enabled", "type": "boolean", "default": false, "example": true }, "identificationDocument": { "description": "Identification document of the Identity", "type": "string", "maxLength": 255, "example": "ID12345", "nullable": true }, "contactData": { "description": "Contact data of the Identity", "type": "string", "maxLength": 255, "example": "123 Street", "nullable": true }, "password": { "description": "Password of the Identity", "type": "string", "maxLength": 255, "minLength": 8, "example": "Password123", "nullable": true }, "validFrom": { "description": "Valid from date", "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00Z", "nullable": true }, "validTo": { "description": "Valid to date", "type": "string", "format": "date-time", "example": "2023-12-31T23:59:59Z", "nullable": true }, "voucherType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IdentityVoucherType" } ] }, "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "custom1": { "description": "Custom 1", "type": "string", "maxLength": 255, "example": "Custom 1", "nullable": true }, "custom2": { "description": "Custom 2", "type": "string", "maxLength": 255, "example": "Custom 2", "nullable": true }, "custom3": { "description": "Custom 3", "type": "string", "maxLength": 255, "example": "Custom 3", "nullable": true }, "custom4": { "description": "Custom 4", "type": "string", "maxLength": 255, "example": "Custom 4", "nullable": true }, "yubiToken": { "description": "Yubi Token", "type": "string", "maxLength": 45, "minLength": 12, "example": "JBSWY3DPEHPK3PXP ", "nullable": true } }, "type": "object" }, "IdentityResetPasswordTokenRequest": { "required": [ "login" ], "properties": { "login": { "description": "Login", "type": "string", "example": "Guest_123" }, "language": { "$ref": "#/components/schemas/LanguageType" }, "notifyType": { "description": "Verification type", "type": "string", "default": "EMAIL" } }, "type": "object" }, "NewIdentityPasswordRequest": { "required": [ "login", "token", "csrf", "newPassword" ], "properties": { "login": { "description": "Email", "type": "string", "example": "admin@nacview.com" }, "token": { "description": "token", "type": "string", "example": "123456" }, "csrf": { "description": "csrf", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "newPassword": { "description": "new password", "type": "string", "maxLength": 255, "minLength": 8, "example": "Nice-hard-p4ssw0rd" }, "verificationType": { "$ref": "#/components/schemas/CaptivePortalResetPasswordNotify" } }, "type": "object" }, "IdentityVoucherMultiCreateRequest": { "required": [ "quantity", "prefix", "voucherType" ], "properties": { "quantity": { "description": "Quantity to create an identity", "type": "integer", "maximum": 5000, "minimum": 1, "example": 230 }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "validTo": { "description": "Valid to date", "type": "string", "format": "date-time", "example": "2023-12-31T23:59:59Z", "nullable": true }, "prefix": { "description": "Prefix to create identity", "type": "string", "maxLength": 100, "example": "aot" }, "voucherType": { "oneOf": [ { "$ref": "#/components/schemas/IdentityVoucherType" } ] }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "AuthenticateIdentityRequest": { "required": [ "login", "password" ], "properties": { "login": { "description": "Identity login (username)", "type": "string", "maxLength": 255, "example": "johndoe" }, "password": { "description": "Raw password for the Identity", "type": "string", "maxLength": 255, "minLength": 8, "example": "Password123" }, "telephoneNumber": { "description": "Optional information for login with sms code", "type": "string", "nullable": true }, "clientIp": { "description": "Client IP address", "type": "string", "format": "ipv4", "example": "192.0.2.1", "nullable": true }, "clientMac": { "description": "Client MAC address", "type": "string", "example": "00:11:22:33:44:55", "nullable": true }, "clientOs": { "description": "Client operating system", "type": "string", "example": "Windows 10", "nullable": true }, "clientLocale": { "description": "Client locale", "type": "string", "example": "en_US", "nullable": true }, "clientpId": { "description": "Portal parameter pId", "type": "string", "example": "12345", "nullable": true }, "clientnId": { "description": "Portal parameter nId", "type": "string", "example": "10.0.0.1", "nullable": true }, "clientSsid": { "description": "Portal SSID", "type": "string", "example": "Guest_WiFi", "nullable": true }, "clientSite": { "description": "Client Site", "type": "string", "nullable": true } }, "type": "object" }, "IdentityMfaRequiredForLoginResponse": { "required": [ "csrf", "mfaType" ], "properties": { "csrf": { "type": "string" }, "mfaType": { "type": "string" } }, "type": "object" }, "NetworkAuthenticateIdentityRequest": { "required": [ "identity" ], "properties": { "identity": { "$ref": "#/components/schemas/NestedIdentifier" }, "ip": { "description": "Client IP address", "type": "string", "example": "10.10.1.156", "nullable": true }, "clientIp": { "description": "Client IP address", "type": "string", "format": "ipv4", "example": "192.0.2.1", "nullable": true }, "clientMac": { "description": "Client MAC address", "type": "string", "example": "00:11:22:33:44:55", "nullable": true }, "clientOs": { "description": "Client operating system", "type": "string", "example": "Windows 10", "nullable": true }, "clientLocale": { "description": "Client locale", "type": "string", "example": "en_US", "nullable": true }, "clientpId": { "description": "Portal parameter pId", "type": "string", "example": "12345", "nullable": true }, "clientnId": { "description": "Portal parameter nId", "type": "string", "example": "10.0.0.1", "nullable": true }, "clientSsid": { "description": "Portal SSID", "type": "string", "example": "Guest_WiFi", "nullable": true }, "clientSite": { "description": "Client Site", "type": "string", "nullable": true } }, "type": "object" }, "MfaIdentityAuthenticationRequest": { "required": [ "tokenMfa", "mfaType", "csrf" ], "properties": { "tokenMfa": { "description": "Token MFA", "type": "string", "maxLength": 50, "minLength": 6, "example": "421512" }, "mfaType": { "$ref": "#/components/schemas/MfaType" }, "csrf": { "description": "Token CSRF", "type": "string", "example": "421512-2144-4123421-112344" }, "clientIp": { "description": "Client IP address", "type": "string", "format": "ipv4", "example": "192.0.2.1", "nullable": true }, "clientMac": { "description": "Client MAC address", "type": "string", "example": "00:11:22:33:44:55", "nullable": true }, "clientOs": { "description": "Client operating system", "type": "string", "example": "Windows 10", "nullable": true }, "clientLocale": { "description": "Client locale", "type": "string", "example": "en_US", "nullable": true }, "clientpId": { "description": "Portal parameter pId", "type": "string", "example": "12345", "nullable": true }, "clientnId": { "description": "Portal parameter nId", "type": "string", "example": "10.0.0.1", "nullable": true }, "clientSsid": { "description": "Portal SSID", "type": "string", "example": "Guest_WiFi", "nullable": true }, "clientSite": { "description": "Client Site", "type": "string", "nullable": true } }, "type": "object" }, "SendMfaIdentityAuthenticationTokenRequest": { "required": [ "mfaType", "csrf" ], "properties": { "mfaType": { "$ref": "#/components/schemas/MfaType" }, "csrf": { "description": "Token CSRF", "type": "string", "example": "421512-2144-4123421-112344" } }, "type": "object" }, "RegisterIdentityRequest": { "required": [ "captivePortal", "name", "surname", "telephoneNumber" ], "properties": { "captivePortal": { "$ref": "#/components/schemas/NestedIdentifier" }, "name": { "description": "First name of the registrant", "type": "string", "maxLength": 255, "example": "Tester" }, "surname": { "description": "Last name (surname) of the registrant", "type": "string", "maxLength": 255, "example": "Testowy" }, "email": { "description": "Email address of the registrant", "type": "string", "format": "email", "maxLength": 255, "example": "test@testowy.pl", "nullable": true }, "telephoneNumber": { "description": "Phone number of the registrant", "type": "string", "maxLength": 20, "example": "+48123456789" }, "extraFields": { "description": "Any extra fields required by this captive portal (associative array of arbitrary key/value pairs)", "type": "object", "nullable": true }, "clientInfo": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IdentityInformationRequest" } ] }, "authorizationServer": { "description": "External authentication type (if applicable)", "type": "string", "example": null, "nullable": true } }, "type": "object" }, "MacAddressRequest": { "required": [ "name" ], "properties": { "name": { "description": "Name of mac", "type": "string", "maxLength": 255, "example": "00:B0:D0:63:C2:26" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is mac address enabled", "type": "boolean", "default": true, "example": false }, "isWireless": { "description": "is wireless enabled", "type": "boolean", "default": false, "example": false }, "custom1": { "description": "Custom 1", "type": "string", "maxLength": 255, "example": "Custom 1", "nullable": true }, "custom2": { "description": "Custom 2", "type": "string", "maxLength": 255, "example": "Custom 2", "nullable": true }, "custom3": { "description": "Custom 3", "type": "string", "maxLength": 255, "example": "Custom 3", "nullable": true }, "custom4": { "description": "Custom 4", "type": "string", "maxLength": 255, "example": "custom 4", "nullable": true }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "forceIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "ipAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewMacAddressResponse": { "required": [ "id", "name", "isEnabled", "isProfiled", "isWireless", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" } ] }, "isProfiled": { "type": "boolean" }, "isWireless": { "type": "boolean" }, "forceIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "ipAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIpAddressResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "vendor": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MacAddressWakeOnLanRequest": { "properties": { "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "ViewNacviewScoutResponse": { "required": [ "isProfilingEnabled", "isCreatingEndpointEnabled", "isModerationEnabled", "windowsRegistry", "windowsProcesses", "windowsFilesAndDirectories", "windowsServices", "windowsApplications", "macProcesses", "macFilesAndDirectories", "linuxProcesses", "linuxFilesAndDirectories", "statusRefreshInterval", "configRefreshInterval", "dataValidateInterval" ], "properties": { "host": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "isProfilingEnabled": { "type": "boolean" }, "isCreatingEndpointEnabled": { "type": "boolean" }, "isModerationEnabled": { "type": "boolean" }, "windowsRegistry": { "type": "array", "items": { "$ref": "#/components/schemas/ViewWindowsRegistryResponse" } }, "windowsProcesses": { "type": "array", "items": { "type": "string" } }, "windowsFilesAndDirectories": { "type": "array", "items": { "type": "string" } }, "windowsServices": { "type": "array", "items": { "type": "string" } }, "windowsApplications": { "type": "array", "items": { "type": "string" } }, "macProcesses": { "type": "array", "items": { "type": "string" } }, "macFilesAndDirectories": { "type": "array", "items": { "type": "string" } }, "linuxProcesses": { "type": "array", "items": { "type": "string" } }, "linuxFilesAndDirectories": { "type": "array", "items": { "type": "string" } }, "reauthParameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReauthParameter" }, "nullable": true }, "repairPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/RepairProgram" }, "nullable": true }, "objectGroupConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupConfigResponse" }, "nullable": true }, "statusRefreshInterval": { "$ref": "#/components/schemas/StatusRefreshInterval" }, "configRefreshInterval": { "$ref": "#/components/schemas/ConfigRefreshInterval" }, "dataValidateInterval": { "$ref": "#/components/schemas/DataValidateInterval" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "NacviewScoutRequest": { "required": [ "host", "isProfilingEnabled", "isCreatingEndpointEnabled", "isModerationEnabled", "windowsProcesses", "windowsFilesAndDirectories", "windowsServices", "windowsApplications", "macProcesses", "macFilesAndDirectories", "linuxProcesses", "linuxFilesAndDirectories", "statusRefreshInterval", "configRefreshInterval", "dataValidateInterval" ], "properties": { "host": { "type": "string", "maxLength": 255 }, "isProfilingEnabled": { "type": "boolean" }, "isCreatingEndpointEnabled": { "type": "boolean" }, "isModerationEnabled": { "type": "boolean" }, "windowsRegistry": { "type": "array", "items": { "$ref": "#/components/schemas/WindowsRegistryRequest" }, "nullable": true }, "windowsProcesses": { "description": "Windows processes", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "windowsFilesAndDirectories": { "description": "Windows files and directories", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "windowsServices": { "description": "Windows services", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "windowsApplications": { "description": "Windows applications", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "macProcesses": { "description": "Mac processes", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "macFilesAndDirectories": { "description": "Mac files and directories", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "linuxProcesses": { "description": "Linux processes", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "linuxFilesAndDirectories": { "description": "Linux files and directories", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "reauthParameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReauthParameter" }, "nullable": true }, "repairPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/RepairProgram" }, "nullable": true }, "statusRefreshInterval": { "$ref": "#/components/schemas/StatusRefreshInterval" }, "configRefreshInterval": { "$ref": "#/components/schemas/ConfigRefreshInterval" }, "dataValidateInterval": { "$ref": "#/components/schemas/DataValidateInterval" } }, "type": "object" }, "NacviewScoutObjectGroupConfigRequest": { "required": [ "isEnabled", "name", "windowsProcesses", "windowsFilesAndDirectories", "windowsServices", "windowsApplications", "macProcesses", "macFilesAndDirectories", "linuxProcesses", "linuxFilesAndDirectories", "statusRefreshInterval", "configRefreshInterval", "dataValidateInterval", "objectGroup" ], "properties": { "isEnabled": { "type": "boolean" }, "name": { "description": "Config name", "type": "string", "maxLength": 100, "example": "string" }, "windowsRegistry": { "type": "array", "items": { "$ref": "#/components/schemas/WindowsRegistryRequest" }, "nullable": true }, "windowsProcesses": { "description": "Windows processes", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "windowsFilesAndDirectories": { "description": "Windows files and directories", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "windowsServices": { "description": "Windows services", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "windowsApplications": { "description": "Windows applications", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "macProcesses": { "description": "Mac processes", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "macFilesAndDirectories": { "description": "Mac files and directories", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "linuxProcesses": { "description": "Linux processes", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "linuxFilesAndDirectories": { "description": "Linux files and directories", "type": "array", "items": { "type": "string" }, "example": [ "name1", "name2" ] }, "reauthParameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReauthParameter" }, "nullable": true }, "repairPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/RepairProgram" }, "nullable": true }, "statusRefreshInterval": { "$ref": "#/components/schemas/StatusRefreshInterval" }, "configRefreshInterval": { "$ref": "#/components/schemas/ConfigRefreshInterval" }, "dataValidateInterval": { "$ref": "#/components/schemas/DataValidateInterval" }, "objectGroup": { "$ref": "#/components/schemas/NestedIdentifier" } }, "type": "object" }, "ViewNacviewScoutObjectGroupConfigResponse": { "required": [ "id", "isEnabled", "name", "windowsRegistry", "statusRefreshInterval", "configRefreshInterval", "dataValidateInterval", "objectGroup", "createdAt" ], "properties": { "id": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "windowsRegistry": { "type": "array", "items": { "$ref": "#/components/schemas/ViewWindowsRegistryResponse" } }, "windowsProcesses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "windowsFilesAndDirectories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "windowsServices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "windowsApplications": { "type": "array", "items": { "type": "string" }, "nullable": true }, "macProcesses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "macFilesAndDirectories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "linuxProcesses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "linuxFilesAndDirectories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "reauthParameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReauthParameter" }, "nullable": true }, "repairPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/RepairProgram" }, "nullable": true }, "statusRefreshInterval": { "$ref": "#/components/schemas/StatusRefreshInterval" }, "configRefreshInterval": { "$ref": "#/components/schemas/ConfigRefreshInterval" }, "dataValidateInterval": { "$ref": "#/components/schemas/DataValidateInterval" }, "objectGroup": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "type": "object" }, "NetworkDeviceRequest": { "required": [ "name", "type" ], "properties": { "name": { "description": "Name of network device", "type": "string", "maxLength": 255, "minLength": 1, "example": "TP-link" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "tacacsSecret": { "description": "Tacacs secret network device", "type": "string", "maxLength": 255, "example": "123dqwd", "nullable": true }, "radiusSecret": { "description": "A key for encrypting communication between the switch and the Radius server.", "type": "string", "maxLength": 48, "example": "3e14123", "nullable": true }, "isEnabled": { "description": "Is it active?", "type": "boolean", "default": true, "example": false }, "isMonitoring": { "description": "Is monitoring active?", "type": "boolean", "default": false, "example": false }, "isShowLabel": { "description": "Is label", "type": "boolean", "default": false, "example": false }, "type": { "$ref": "#/components/schemas/NetworkDeviceType" }, "downloadInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DownloadInterval" } ] }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "firmware": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Firmware" } ] }, "controllerMainNetworkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "numberOfPorts": { "type": "integer", "default": 1, "maximum": 1024, "minimum": 1, "example": 16 }, "reauthDeviceCredential": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "deviceCredential": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "deviceCredentialMonitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "ViewNetworkDeviceResponse": { "required": [ "accessType", "id", "name", "numberOfPorts", "isEnabled", "status", "type", "isShowLabel", "createdAt", "isMonitoring" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "numberOfPorts": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "status": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NetworkDeviceStatus" } }, "type": { "$ref": "#/components/schemas/NetworkDeviceType" }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSectorResponse" } ] }, "radiusSecret": { "type": "string", "nullable": true }, "tacacsSecret": { "type": "string", "nullable": true }, "firmware": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Firmware" } ] }, "isShowLabel": { "type": "boolean" }, "ports": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDevicePortResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "controllerMainNetworkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "controlledNetworkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "reauthDeviceCredential": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListReauthDeviceCredentialResponse" } ] }, "deviceCredential": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" } ] }, "deviceCredentialMonitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" } ] }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "monitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NetworkDeviceMonitoring" } ] }, "isMonitoring": { "type": "boolean" }, "downloadInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DownloadInterval" } ] } }, "type": "object" }, "CloneNetworkDeviceRequest": { "required": [ "name", "portCount", "ipAddress" ], "properties": { "name": { "description": "name of the new cloned device", "type": "string", "example": "network-device-clone1" }, "portCount": { "description": "count of ports for the new cloned device", "type": "integer", "maximum": 2048, "minimum": 1, "example": 13 }, "ipAddress": { "$ref": "#/components/schemas/NestedIdentifier" } }, "type": "object" }, "NetworkDeviceExecuteApiCommandRequest": { "required": [ "commands" ], "properties": { "commands": { "description": "Commands to exec on remote network device", "type": "string", "maxLength": 2056, "minLength": 1, "example": "vlan 10; interface vlan 10; channel-group 1 mode active; username admin secret haslo123; ip access-list extended BLOKADA; enable secret haslo; no vlan 20" } }, "type": "object" }, "NetworkDeviceReauthRequest": { "required": [ "mac", "systemNode" ], "properties": { "mac": { "description": "MAC Address", "type": "string", "example": "00:11:22:33:44:55" }, "systemNode": { "$ref": "#/components/schemas/NestedIdentifier" }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "ProfilingDefinitionRequest": { "required": [ "name", "isEnabled", "isTerminateOnSuccess", "manufacturer", "osFamily", "osName", "osVersion", "deviceModel", "strategy" ], "properties": { "name": { "description": "Name of the ProfilingDefinition", "type": "string", "maxLength": 255, "example": "John" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "ProfilingDefinition is enabled", "type": "boolean", "example": true }, "isTerminateOnSuccess": { "description": "Terminate when success", "type": "boolean", "example": true }, "manufacturer": { "description": "Device manufacturer", "type": "string", "maxLength": 255, "example": "John" }, "osFamily": { "description": "Operating System Family ", "type": "string", "maxLength": 255, "example": "John" }, "osName": { "description": "Operating System Name ", "type": "string", "maxLength": 255, "example": "John" }, "osVersion": { "description": "Operating System Version ", "type": "string", "maxLength": 255, "example": "John" }, "deviceModel": { "description": "Device model", "type": "string", "maxLength": 255, "example": "John" }, "strategy": { "$ref": "#/components/schemas/ProfilingRuleStrategyType" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewProfilingDefinitionResponse": { "required": [ "id", "name", "isEnabled", "isTerminateOnSuccess", "strategy", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "isTerminateOnSuccess": { "type": "boolean" }, "manufacturer": { "type": "string", "nullable": true }, "osFamily": { "type": "string", "nullable": true }, "osName": { "type": "string", "nullable": true }, "osVersion": { "type": "string", "nullable": true }, "deviceModel": { "type": "string", "nullable": true }, "strategy": { "$ref": "#/components/schemas/ProfilingRuleStrategyType" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "profilingDefinitionRules": { "type": "array", "items": { "$ref": "#/components/schemas/ViewProfilingDefinitionRuleResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "AssignProfilingDefinitionRuleRequest": { "properties": { "profilingDefinitionRules": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilingDefinitionRuleRequest" }, "nullable": true } }, "type": "object" }, "ReauthDeviceCredentialRequest": { "required": [ "name", "type", "macType", "coaFormat", "reauthCoaType" ], "properties": { "name": { "description": "Name of reauth device credentials", "type": "string", "maxLength": 255, "minLength": 1, "example": "TP-link" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "type": { "$ref": "#/components/schemas/ConnectionType" }, "isEnabled": { "description": "Is it active?", "type": "boolean", "default": true, "example": false }, "connectOid": { "description": "Description of network device", "type": "string", "maxLength": 255, "example": "Some random network device description", "nullable": true }, "disconnectOid": { "description": "Description of network device", "type": "string", "maxLength": 255, "example": "Some random network device description", "nullable": true }, "telnetDisconnect": { "description": "Description of network device", "type": "string", "maxLength": 255, "example": "Some random network device description", "nullable": true }, "isDeviceSecret": { "description": "Is it active?", "type": "boolean", "default": true, "example": false }, "secret": { "description": "Description of network device", "type": "string", "maxLength": 255, "example": "Some random network device description", "nullable": true }, "macType": { "$ref": "#/components/schemas/MacType" }, "coaFormat": { "$ref": "#/components/schemas/CoaFormat" }, "reauthCoaType": { "$ref": "#/components/schemas/ReauthCoaType" }, "port": { "description": "Description of network device", "type": "string", "maxLength": 20, "example": "Some random network device description", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "customCoaFormat": { "description": "Custom coa format", "type": "string", "nullable": true } }, "type": "object" }, "ViewReauthDeviceCredentialResponse": { "required": [ "id", "name", "isDeviceSecret", "type", "isEnabled", "macType", "coaFormat", "reauthCoaType", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isDeviceSecret": { "type": "boolean" }, "secret": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ConnectionType" }, "isEnabled": { "type": "boolean" }, "connectOid": { "type": "string", "nullable": true }, "disconnectOid": { "type": "string", "nullable": true }, "telnetDisconnect": { "type": "string", "nullable": true }, "port": { "type": "string", "nullable": true }, "macType": { "$ref": "#/components/schemas/MacType" }, "coaFormat": { "$ref": "#/components/schemas/CoaFormat" }, "reauthCoaType": { "$ref": "#/components/schemas/ReauthCoaType" }, "customCoaFormat": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListCaptivePortalResponse": { "required": [ "id", "name", "code", "isEnabled", "isMaster", "isRedirectToHttps", "preferredLocale", "isRequireSponsor", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "isMaster": { "type": "boolean" }, "isRedirectToHttps": { "type": "boolean" }, "preferredLocale": { "$ref": "#/components/schemas/CaptivePortalPreferredLocale" }, "urlAddress": { "type": "string", "nullable": true }, "isRequireSponsor": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "pki": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListPkiResponse" } ] }, "captivePortalSponsors": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalSponsorResponse" }, "nullable": true }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "socialAuthorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "nullable": true }, "apiAuthorizationServers": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "nullable": true }, "nacviewAssistants": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNacviewAssistantResponse" }, "nullable": true }, "registerObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "registrationForms": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalRegistrationFormResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListCaptivePortalResponse": { "required": [ "id", "name", "isEnabled", "code" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "code": { "type": "integer" } }, "type": "object" }, "ViewDefaultCaptivePortalIdentityResponse": { "required": [ "id", "isEnabled" ], "properties": { "id": { "type": "integer" }, "firstName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListCaptivePortalObjectGroupConfigResponse": { "required": [ "id", "name", "isEnabled", "objectGroup", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "objectGroup": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListCaptivePortalObjectGroupConfigResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "objectGroup": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListObjectGroupResponse" } ] } }, "type": "object" }, "ListCaptivePortalRegistrationFormResponse": { "required": [ "id", "name", "isEnabled", "type", "isRequired", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/CaptivePortalRegistrationFormType" }, "isRequired": { "type": "boolean" }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListCaptivePortalRegistrationFormResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListCaptivePortalSponsorResponse": { "required": [ "id", "name", "isEnabled", "email", "locale", "activateDestinationType", "isEmailAsLogin", "loginMinimumLength", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "email": { "type": "string" }, "code": { "type": "string", "nullable": true }, "locale": { "$ref": "#/components/schemas/LanguageType" }, "activateDestinationType": { "$ref": "#/components/schemas/DestinationType" }, "isEmailAsLogin": { "type": "boolean" }, "loginMinimumLength": { "type": "integer" }, "validitySetOnActivation": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CaptivePortalValidity" } ] }, "createdAt": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "captivePortals": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" }, "nullable": true }, "sponsorObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "registrationObjectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "registrationAccessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListCaptivePortalSponsorResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ViewCaptivePortalSubmitResponse": { "required": [ "id", "formData", "clientData", "isToActivate", "hash", "identityName", "identitySurname", "identityEmail", "identityTelephoneNumber", "accessType" ], "properties": { "id": { "type": "integer" }, "formData": { "type": "object", "additionalProperties": {} }, "clientData": { "$ref": "#/components/schemas/IdentityMetadata" }, "isToActivate": { "type": "boolean" }, "notifyDate": { "type": "string", "nullable": true }, "hash": { "type": "string" }, "identityName": { "type": "string" }, "identitySurname": { "type": "string" }, "identityEmail": { "type": "string" }, "identityTelephoneNumber": { "type": "string" }, "sponsorNotifyEmail": { "type": "string", "nullable": true }, "approved": { "type": "string", "nullable": true }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "captivePortal": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListCaptivePortalResponse" } ] }, "captivePortalSponsor": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListCaptivePortalSponsorResponse" } ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EndpointDeviceGraphListResponse": { "required": [ "deviceGraphId", "endpointDeviceId", "graph", "enabled" ], "properties": { "deviceGraphId": { "type": "integer" }, "endpointDeviceId": { "type": "integer" }, "graph": { "type": "string" }, "enabled": { "type": "boolean" } }, "type": "object" }, "ViewGraphRequest": { "required": [ "width", "height", "interval", "to", "timestamp", "period" ], "properties": { "width": { "type": "integer", "example": 1 }, "height": { "type": "integer", "example": 100 }, "interval": { "type": "integer", "example": 86400 }, "to": { "type": "integer", "example": 1630000000 }, "timestamp": { "type": "integer", "example": 1630000000 }, "period": { "type": "integer", "example": 86400 }, "legend": { "type": "boolean", "default": true, "example": true } }, "type": "object" }, "MonitoringGraphResponse": { "required": [ "graphBase64" ], "properties": { "graphBase64": { "type": "string" } }, "type": "object" }, "MonitoringDevicesResponse": { "required": [ "id", "deviceUuid", "hostname", "snmpVersion", "status", "statusType", "portsResponse" ], "properties": { "id": { "type": "integer" }, "deviceUuid": { "type": "string", "format": "uuid" }, "hostname": { "type": "string" }, "ip": { "type": "string", "nullable": true }, "snmpAuthLevel": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SnmpAuthLevel" } ] }, "snmpAuthName": { "type": "string", "nullable": true }, "snmpAuthPass": { "type": "string", "nullable": true }, "snmpCryptopass": { "type": "string", "nullable": true }, "snmpCommunity": { "type": "string", "nullable": true }, "snmpVersion": { "$ref": "#/components/schemas/SnmpVersion" }, "snmpCryptoAlgo": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SnmpCryptoalgo" } ] }, "snmpAuthAlgo": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SnmpAuthAlgo" } ] }, "status": { "type": "integer" }, "statusType": { "$ref": "#/components/schemas/StatusType" }, "portsResponse": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringPortsResponse" } } }, "type": "object" }, "MiniListEndpointDeviceResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "secondName": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListEndpointDeviceResponse": { "required": [ "id", "name", "isOnline", "isScoutModerated", "isEnabled", "isMonitoring", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "secondName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EndpointType" } ] }, "inventoryNumber": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isOnline": { "type": "boolean" }, "isScoutModerated": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "scoutUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "externalIntegrationId": { "type": "string", "nullable": true }, "scoutStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ScoutStatus" } ] }, "organizationUnit": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" } ] }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "authorizationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" } ] }, "deviceCredentialMonitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" } ] }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceParameterResponse" }, "nullable": true }, "macAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListMacAddressResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSectorResponse" } ] }, "isMonitoring": { "type": "boolean" }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListEndpointDeviceParameterResponse": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "IdentityPrintRequest": { "required": [ "printableTemplate", "identity" ], "properties": { "printableTemplate": { "$ref": "#/components/schemas/NestedIdentifier" }, "identity": { "$ref": "#/components/schemas/NestedIdentifier" } }, "type": "object" }, "IdentityPrintBulkRequest": { "required": [ "printableTemplate" ], "properties": { "printableTemplate": { "$ref": "#/components/schemas/NestedIdentifier" }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ListIdentityResponse": { "required": [ "id", "isEnabled", "login", "nacviewSecret", "googleSecret", "type", "authorizationServer", "accessType" ], "properties": { "id": { "type": "integer" }, "firstName": { "type": "string", "nullable": true }, "secondName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "telephoneNumber": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "identificationDocument": { "type": "string", "nullable": true }, "contactData": { "type": "string", "nullable": true }, "login": { "type": "string" }, "secondLogin": { "type": "string", "nullable": true }, "nacviewSecret": { "type": "string" }, "googleSecret": { "type": "string" }, "validFrom": { "type": "string", "nullable": true }, "validTo": { "type": "string", "nullable": true }, "maxConcurrentDevices": { "type": "integer", "nullable": true }, "externalIntegrationId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/IdentityType" }, "voucherType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IdentityVoucherType" } ] }, "createdAt": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListIdentityResponse": { "required": [ "identityType", "id", "isEnabled" ], "properties": { "identityType": { "$ref": "#/components/schemas/IdentityType" }, "id": { "type": "integer" }, "firstName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "secondLogin": { "type": "string", "nullable": true }, "telephoneNumber": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListMacAddressResponse": { "required": [ "id", "name", "isEnabled", "isProfiled", "isWireless", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" } ] }, "isProfiled": { "type": "boolean" }, "isWireless": { "type": "boolean" }, "forceIpAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "ipAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIpAddressResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "vendor": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListMacAddressResponse": { "required": [ "id", "name", "isEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListMacAddressVendorResponse": { "required": [ "id", "macBase", "vendor", "accessType" ], "properties": { "id": { "type": "integer" }, "macBase": { "type": "string" }, "vendor": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListNacviewScoutObjectGroupConfigResponse": { "required": [ "id", "isEnabled", "name", "statusRefreshInterval", "configRefreshInterval", "dataValidateInterval", "objectGroup", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "statusRefreshInterval": { "$ref": "#/components/schemas/StatusRefreshInterval" }, "configRefreshInterval": { "$ref": "#/components/schemas/ConfigRefreshInterval" }, "dataValidateInterval": { "$ref": "#/components/schemas/DataValidateInterval" }, "objectGroup": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "createdAt": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListNacviewScoutObjectGroupConfigResponse": { "required": [ "id", "isEnabled", "name" ], "properties": { "id": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "ListNetworkDeviceConfigResponse": { "required": [ "uuid", "networkDeviceId", "createdAt" ], "properties": { "uuid": { "type": "string", "format": "uuid" }, "systemNodeId": { "type": "integer", "nullable": true }, "networkDeviceId": { "type": "integer" }, "createdAt": { "type": "string" } }, "type": "object" }, "ViewNetworkDeviceConfigResponse": { "required": [ "uuid", "networkDeviceId", "config", "createdAt" ], "properties": { "uuid": { "type": "string", "format": "uuid" }, "systemNodeId": { "type": "integer", "nullable": true }, "networkDeviceId": { "type": "integer" }, "config": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "MiniListNetworkDeviceResponse": { "required": [ "id", "name", "isEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/NetworkDeviceType" } }, "type": "object" }, "ListNetworkDeviceResponse": { "required": [ "id", "name", "isEnabled", "type", "isMonitoring", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSectorResponse" } ] }, "type": { "$ref": "#/components/schemas/NetworkDeviceType" }, "ipAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIpAddressResponse" } ] }, "firmware": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Firmware" } ] }, "controllerMainNetworkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "reauthDeviceCredential": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListReauthDeviceCredentialResponse" } ] }, "deviceCredential": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" } ] }, "deviceCredentialMonitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListDeviceCredentialResponse" } ] }, "objectGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListObjectGroupResponse" }, "nullable": true }, "controlledNetworkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "monitoring": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NetworkDeviceMonitoring" } ] }, "isMonitoring": { "type": "boolean" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "NetworkDeviceGraphListResponse": { "required": [ "deviceGraphId", "endpointDeviceId", "graph", "enabled" ], "properties": { "deviceGraphId": { "type": "integer" }, "endpointDeviceId": { "type": "integer" }, "graph": { "type": "string" }, "enabled": { "type": "boolean" } }, "type": "object" }, "PortGraphListResponse": { "required": [ "portId", "graph", "enabled" ], "properties": { "portId": { "type": "integer" }, "graph": { "type": "string" }, "enabled": { "type": "boolean" } }, "type": "object" }, "ListProfilingDefinitionResponse": { "required": [ "id", "name", "isEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "manufacturer": { "type": "string", "nullable": true }, "osFamily": { "type": "string", "nullable": true }, "osName": { "type": "string", "nullable": true }, "osVersion": { "type": "string", "nullable": true }, "deviceModel": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListProfilingDefinitionResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "MiniListReauthDeviceCredentialResponse": { "required": [ "id", "name", "isEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/ConnectionType" } }, "type": "object" }, "ListReauthDeviceCredentialResponse": { "required": [ "id", "name", "type", "isEnabled", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ConnectionType" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "SmsApiCreatorSmsRequest": { "required": [ "isEnabled", "sender", "token" ], "properties": { "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "token": { "description": "Token to sms api", "type": "string", "example": "0000-00000-0000" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "GsmServiceCreatorSmsRequest": { "required": [ "sender", "isEnabled", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "SerwerSmsCreatorSmsRequest": { "required": [ "sender", "isEnabled", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "AfilnetCreatorSmsRequest": { "required": [ "sender", "isEnabled", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "ClickatellCreatorSmsRequest": { "required": [ "isEnabled", "sender", "token" ], "properties": { "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "token": { "description": "Token to sms api", "type": "string", "example": "0000-00000-0000" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "AspSmsCreatorSmsRequest": { "required": [ "sender", "isEnabled", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "HostedSmsCreatorSmsRequest": { "required": [ "sender", "isEnabled", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "IntelliSmsCreatorSmsRequest": { "required": [ "sender", "isEnabled", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "VonageCreatorSmsRequest": { "required": [ "sender", "isEnabled", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "SmsEagleCreatorSmsRequest": { "required": [ "isEnabled", "token", "host" ], "properties": { "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "token": { "description": "Token to sms api", "type": "string", "example": "0000-00000-0000" }, "host": { "description": "Host of your sms server", "type": "string", "example": "sms-gateway.company.com" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "NowSmsCreatorSmsRequest": { "required": [ "isEnabled", "login", "password", "host" ], "properties": { "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "host": { "description": "Host of your sms server", "type": "string", "example": "sms-gateway.company.com" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "SwisscomCreatorSmsRequest": { "required": [ "isEnabled", "token" ], "properties": { "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "token": { "description": "Token to sms api", "type": "string", "example": "0000-00000-0000" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "OvhSmsCreatorSmsRequest": { "required": [ "sender", "isEnabled", "account", "login", "password" ], "properties": { "sender": { "description": "Name of sms sender.", "type": "string", "example": "NACVIEW" }, "isEnabled": { "description": "Is creator sms enabled", "type": "boolean" }, "account": { "description": "Api account", "type": "string", "example": "qwerty" }, "login": { "description": "Login to sms api", "type": "string", "example": "nacview" }, "password": { "description": "Password to sms api", "type": "string", "example": "qwerty123" }, "testPhoneNumber": { "description": "Recipient phone number to send test sms.", "type": "string", "default": "null", "example": "+48123456789", "nullable": true } }, "type": "object" }, "ViewSmtpResponse": { "required": [ "fromName", "senderEmail", "connectionProtocol", "authorizationType", "connectionPort", "encryption", "isEmptyPassword" ], "properties": { "fromName": { "type": "string" }, "senderEmail": { "type": "string" }, "connectionProtocol": { "$ref": "#/components/schemas/SmtpConnectionProtocolType" }, "mailServer": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "authorizationType": { "$ref": "#/components/schemas/SmtpAuthType" }, "connectionPort": { "type": "integer" }, "encryption": { "$ref": "#/components/schemas/SmtpEncryptionType" }, "isEmptyPassword": { "type": "boolean" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "CreatorSmtpRequest": { "required": [ "fromName", "senderEmail", "connectionProtocol", "mailServer", "authorizationType", "connectionPort", "encryption", "isEmptyPassword" ], "properties": { "fromName": { "description": "From email name\"", "type": "string", "example": "NACVIEW System" }, "senderEmail": { "description": "Sender email", "type": "string", "example": "noreply@nacview.com" }, "connectionProtocol": { "$ref": "#/components/schemas/SmtpConnectionProtocolType" }, "mailServer": { "description": "Mail server", "type": "string", "example": "mailcatcher" }, "username": { "description": "Username mailserver", "type": "string", "example": "", "nullable": true }, "password": { "description": "Password mailserver", "type": "string", "example": "", "nullable": true }, "authorizationType": { "$ref": "#/components/schemas/SmtpAuthType" }, "connectionPort": { "description": "Connection port", "type": "integer", "example": 25 }, "encryption": { "$ref": "#/components/schemas/SmtpEncryptionType" }, "isEmptyPassword": { "description": "Empty password", "type": "boolean", "example": true } }, "type": "object" }, "SendEmailRequest": { "properties": { "language": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LanguageType" } ] }, "subject": { "description": "title of email", "type": "string", "example": "This is a custom email message.", "nullable": true }, "body": { "description": "message to send", "type": "string", "example": "This is a custom email message.", "nullable": true }, "user": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "NotificationChannelRequest": { "required": [ "name", "isEnabled", "type" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "isEnabled": { "type": "boolean" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "type": { "$ref": "#/components/schemas/NotificationType" }, "notifyTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NotifyTime" } ] }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationModule" }, "nullable": true }, "syslogHost": { "type": "string", "maxLength": 255, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "integrationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "ViewNotificationChannelResponse": { "required": [ "id", "name", "isEnabled", "type", "modules", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/NotificationType" }, "notifyTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NotifyTime" } ] }, "syslogHost": { "type": "string", "nullable": true }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationModule" } }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "integrationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIntegrationServerResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListUserResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewNotificationTemplateResponse": { "required": [ "id", "lang", "purpose", "subject", "body", "name", "createdAt", "isEnabled", "notificationTemplateType", "accessType" ], "properties": { "id": { "type": "integer" }, "lang": { "type": "string" }, "purpose": { "$ref": "#/components/schemas/NotificationTemplatePurposeTypeEnum" }, "subject": { "type": "string" }, "body": { "type": "string" }, "allowedTemplateVariables": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "notificationTemplateType": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "NotificationTemplateRequest": { "required": [ "subject", "body", "name", "isEnabled" ], "properties": { "subject": { "description": "Subject of notification template", "type": "string", "example": "Account activation" }, "body": { "description": "body of email", "type": "string", "example": "Your account has been activated by network administrator." }, "name": { "description": "name of email", "type": "string", "example": "Reset password." }, "isEnabled": { "description": "is enabled notification template", "type": "boolean", "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "SendSmsRequest": { "required": [ "telephoneNumber", "completingForBodyText" ], "properties": { "telephoneNumber": { "description": "Recipient telephone number", "type": "string", "example": "+441115222333" }, "completingForBodyText": { "description": "key-value pairs that are use to fill template.", "type": "array", "items": { "type": [ "string" ] }, "example": { "TOKEN": "834265", "ACTION": "login" } }, "language": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LanguageType" } ] }, "templateType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NotificationTemplateTypeEnum" } ] }, "rawMessage": { "description": "Recipient telephone number", "type": "string", "example": "Token: 123456", "nullable": true } }, "type": "object" }, "SendSmsResponse": { "properties": { "responseContent": { "type": "string", "default": null, "nullable": true }, "responseCode": { "type": "integer", "default": null, "nullable": true } }, "type": "object" }, "ViewCreatorSmsResponse": { "required": [ "configurationPriority", "isEnabled" ], "properties": { "configurationPriority": { "type": "string" }, "isEnabled": { "type": "boolean" }, "serviceType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmsServiceTypeEnum" } ] }, "sender": { "type": "string", "nullable": true }, "account": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "host": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "ViewNotificationResponse": { "required": [ "id", "uuid", "isProgress", "messageCode", "triggeredByCategory", "createdAt", "counter" ], "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "duration": { "type": "integer", "nullable": true }, "isProgress": { "type": "boolean" }, "messageCode": { "$ref": "#/components/schemas/NotificationMessageType" }, "messageError": { "type": "string", "nullable": true }, "triggeredByCategory": { "$ref": "#/components/schemas/TriggeredByCategory" }, "status": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NotificationStatus" } ] }, "createdAt": { "type": "string" }, "finishedAt": { "type": "string", "nullable": true }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/ViewNotificationMessageResponse" }, "nullable": true }, "counter": { "type": "integer" } }, "type": "object" }, "ListNotificationResponse": { "required": [ "id", "isProgress", "messageCode", "triggeredByCategory", "createdAt", "counter", "accessType" ], "properties": { "id": { "type": "integer" }, "isProgress": { "type": "boolean" }, "messageCode": { "$ref": "#/components/schemas/NotificationMessageType" }, "triggeredByCategory": { "$ref": "#/components/schemas/TriggeredByCategory" }, "status": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NotificationStatus" } ] }, "createdAt": { "type": "string" }, "counter": { "type": "integer" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListNotificationChannelResponse": { "required": [ "id", "name", "isEnabled", "modules", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NotificationType" } ] }, "notifyTime": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NotifyTime" } ] }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationModule" } }, "createdAt": { "type": "string" }, "integrationServer": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIntegrationServerResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListUserResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListNotificationChannelResponse": { "required": [ "type", "id", "name", "isEnabled" ], "properties": { "type": { "$ref": "#/components/schemas/NotificationType" }, "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListNotificationTemplateResponse": { "required": [ "id", "subject", "purpose", "lang", "name", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "subject": { "type": "string" }, "purpose": { "$ref": "#/components/schemas/NotificationTemplatePurposeTypeEnum" }, "lang": { "type": "string" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListNotificationTemplateResponse": { "required": [ "id", "subject", "lang", "name", "isEnabled", "purpose" ], "properties": { "id": { "type": "integer" }, "subject": { "type": "string" }, "lang": { "type": "string" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "purpose": { "$ref": "#/components/schemas/NotificationTemplatePurposeTypeEnum" } }, "type": "object" }, "NewDeviceCredentialRequest": { "required": [ "type", "name", "isEnabled" ], "properties": { "type": { "$ref": "#/components/schemas/DeviceCredentialsTypeEnum" }, "name": { "description": "name of the device credentials", "type": "string", "maxLength": 255, "example": "Device example 1" }, "login": { "description": "login of the device credentials", "type": "string", "maxLength": 255, "example": "log1n", "nullable": true }, "password": { "description": "password of the device credentials", "type": "string", "maxLength": 255, "minLength": 8, "example": "p4ssw0rd", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "example": true }, "cryptoPassword": { "description": "crypto password", "type": "string", "maxLength": 255, "minLength": 8, "example": "cryptoPassword", "nullable": true }, "cliOptions": { "description": "cli options", "type": "string", "example": "cliOptions", "nullable": true }, "cliPort": { "description": "cli port", "type": "integer", "maximum": 65535, "minimum": 1, "example": 22, "nullable": true }, "authLevel": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthLevelEnum" } ] }, "authAlgorithm": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthAlgorithmEnum" } ] }, "authConnection": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthConnectionEnum" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewDeviceCredentialResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "type", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "cryptoPassword": { "type": "string", "nullable": true }, "cliOptions": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/DeviceCredentialsTypeEnum" }, "authLevel": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthLevelEnum" } ] }, "authAlgorithm": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthAlgorithmEnum" } ] }, "authConnection": { "type": "string", "nullable": true }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "cliPort": { "type": "integer", "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditDeviceCredentialRequest": { "required": [ "name", "isEnabled" ], "properties": { "name": { "description": "name of the device credentials", "type": "string", "maxLength": 255, "example": "Device example 1" }, "login": { "description": "login of the device credentials", "type": "string", "maxLength": 255, "example": "log1n", "nullable": true }, "password": { "description": "password of the device credentials", "type": "string", "maxLength": 255, "minLength": 8, "example": "p4ssw0rd", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "example": true }, "cryptoPassword": { "description": "crypto password", "type": "string", "maxLength": 255, "minLength": 8, "example": "cryptoPassword", "nullable": true }, "cliOptions": { "description": "cli options", "type": "string", "example": "cliOptions", "nullable": true }, "cliPort": { "description": "cli port", "type": "integer", "maximum": 65535, "minimum": 1, "example": 22, "nullable": true }, "authLevel": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthLevelEnum" } ] }, "authAlgorithm": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthAlgorithmEnum" } ] }, "authConnection": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthConnectionEnum" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "NewOrganizationUnitRequest": { "required": [ "name", "isEnabled", "authorizationServer" ], "properties": { "name": { "description": "name of the unit", "type": "string", "maxLength": 255, "example": "OrganizationUnit 1" }, "symbol": { "description": "symbol of the unit", "type": "string", "maxLength": 255, "example": "U1", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "example": true }, "parentUnit": { "properties": { "id": { "description": "id of parent unit", "type": "integer", "example": 1 } }, "type": "object", "default": null, "nullable": true }, "externalIntegrationId": { "description": "external integration id of the unit", "type": "string", "maxLength": 255, "example": "external integration id", "nullable": true }, "authorizationServer": { "properties": { "id": { "description": "Id of authorization server", "type": "integer", "example": 1 } }, "type": "object" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewOrganizationUnitResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "authorizationServer", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "externalAuthChangeDate": { "type": "string", "format": "date-time", "nullable": true }, "symbol": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "externalIntegrationId": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "externalIntegrationUid": { "type": "string", "nullable": true }, "authorizationServer": { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" }, "parentUnit": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" } ] }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIdentityResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "EditOrganizationUnitRequest": { "required": [ "name", "isEnabled" ], "properties": { "name": { "description": "name of the unit", "type": "string", "maxLength": 255, "example": "OrganizationUnit 1" }, "symbol": { "description": "symbol of the unit", "type": "string", "maxLength": 255, "example": "U1", "nullable": true }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "example": true }, "parentUnit": { "properties": { "id": { "description": "Id of organization unit", "type": "integer", "example": 1 } }, "type": "object", "default": null, "nullable": true }, "externalAuthChangeDate": { "description": "expiry date of the user account", "type": "string", "example": "2017-07-21 05:05:05", "nullable": true }, "endpointDevice": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ListDeviceCredentialResponse": { "required": [ "id", "name", "isEnabled", "type", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "login": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "authLevel": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthLevelEnum" } ] }, "authAlgorithm": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeviceCredentialsAuthAlgorithmEnum" } ] }, "type": { "$ref": "#/components/schemas/DeviceCredentialsTypeEnum" }, "createdAt": { "type": "string" }, "networkDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListDeviceCredentialResponse": { "required": [ "id", "name", "isEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/DeviceCredentialsTypeEnum" } }, "type": "object" }, "ListOrganizationUnitResponse": { "required": [ "id", "name", "isEnabled", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "symbol": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "externalIntegrationId": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "authorizationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" } ] }, "parentUnit": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" } ] }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListIdentityResponse" }, "nullable": true }, "endpointDevices": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListOrganizationUnitResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "authorizationServer": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListAuthorizationServerResponse" } ] }, "parentUnit": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListOrganizationUnitResponse" } ] } }, "type": "object" }, "EventDefinitionRequest": { "required": [ "name", "isEnabled", "source", "action", "timeUnit", "actionUrl", "actionHttpPostData", "phrases" ], "properties": { "name": { "description": "name of event definition", "type": "string", "maxLength": 255, "example": "OrganizationUnit" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "Description", "nullable": true }, "isEnabled": { "description": "is enabled", "type": "boolean", "example": true }, "source": { "$ref": "#/components/schemas/EventSource" }, "template": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TemplateType" } ] }, "action": { "$ref": "#/components/schemas/ActionType3" }, "timeUnit": { "$ref": "#/components/schemas/TimeUnit" }, "actionHttpRequestType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionHttpRequestType" } ] }, "actionUrl": { "description": "actionUrl of event definition", "type": "string", "maxLength": 255, "example": "http://example.com" }, "actionHttpPostData": { "description": "actionHttpPostData of event definition", "type": "string", "maxLength": 255, "example": "some payload" }, "phrases": { "description": "phrases of event definition", "type": "array", "items": { "type": "string" }, "example": [ "example1", "example2" ] }, "integrationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewEventDefinitionResponse": { "required": [ "id", "name", "isEnabled", "source", "action", "timeUnit", "createdAt", "phrases", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/EventSource" }, "template": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TemplateType" } ] }, "action": { "$ref": "#/components/schemas/ActionType3" }, "timeUnit": { "$ref": "#/components/schemas/TimeUnit" }, "actionUrl": { "type": "string", "nullable": true }, "actionHttpPostData": { "type": "string", "nullable": true }, "actionHttpRequestType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ActionHttpRequestType" } ] }, "integrationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIntegrationServerResponse" } ] }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string", "nullable": true }, "phrases": { "type": "array", "items": { "type": "string" }, "example": [ "printer", "exec" ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "QueueRebuildConfiguration": { "properties": { "rebuildConfigurator": { "type": "array", "items": { "$ref": "#/components/schemas/QueueRebuildConfigurator" }, "default": [] } }, "type": "object" }, "ViewQueueResponse": { "required": [ "id", "name", "intervalId", "pendingJobsNumber", "failedJobsNumber", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "uptime": { "type": "string", "nullable": true }, "lastRun": { "type": "string", "nullable": true }, "intervalValue": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IntervalJobsEnum" } ] }, "intervalId": { "type": "integer" }, "pendingJobsNumber": { "type": "integer" }, "failedJobsNumber": { "type": "integer" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "type": "object" }, "ChangeActivityJobQueueRequest": { "required": [ "isActive" ], "properties": { "isActive": { "description": "Change of activity", "type": "boolean", "example": "true" } }, "type": "object" }, "ChangeIntervalJobQueueRequest": { "required": [ "intervalId" ], "properties": { "intervalId": { "description": "Id of dictionary item", "type": "string", "enum": [ "P1D", "P1M", "P3M", "P7D", "PT15M", "PT1H", "PT30M", "PT3H", "PT5M" ], "example": "P1D" } }, "type": "object" }, "MiniListEventDefinitionResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "ListEventDefinitionResponse": { "required": [ "id", "name", "isEnabled", "source", "action", "timeUnit", "createdAt", "phrases", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/EventSource" }, "template": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TemplateType" } ] }, "action": { "$ref": "#/components/schemas/ActionType3" }, "timeUnit": { "$ref": "#/components/schemas/TimeUnit" }, "integrationServer": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIntegrationServerResponse" } ] }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListNotificationChannelResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "createdAt": { "type": "string" }, "phrases": { "type": "array", "items": { "type": "string" }, "example": [ "printer", "exec" ] }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "LogEventDefinitionResponse": { "required": [ "message" ], "properties": { "message": { "type": "string" } }, "type": "object" }, "ViewCreatorSyslogResponse": { "required": [ "isSyslogEnabled", "isSyslogArchive", "isSyslogForward", "syslogDhcpDiscover", "syslogDhcpOffer", "syslogDhcpAck", "syslogDhcpNak", "syslogDhcpRequest", "syslogDhcpInform", "syslogDhcpDecline", "syslogAuthAccess", "syslogAuthReject", "syslogOtpAccept", "syslogOtpAccess", "syslogOtpReject", "syslogHosts", "syslogFilterProcess", "syslogFilterSeverity", "syslogFilterHost", "syslogFilterMessage" ], "properties": { "isSyslogEnabled": { "type": "boolean" }, "isSyslogArchive": { "type": "boolean" }, "isSyslogForward": { "type": "boolean" }, "syslogDhcpDiscover": { "type": "string" }, "syslogDhcpOffer": { "type": "string" }, "syslogDhcpAck": { "type": "string" }, "syslogDhcpNak": { "type": "string" }, "syslogDhcpRequest": { "type": "string" }, "syslogDhcpInform": { "type": "string" }, "syslogDhcpDecline": { "type": "string" }, "syslogAuthAccess": { "type": "string" }, "syslogAuthReject": { "type": "string" }, "syslogOtpAccept": { "type": "string" }, "syslogOtpAccess": { "type": "string" }, "syslogOtpReject": { "type": "string" }, "syslogHosts": { "type": "array", "items": { "type": "string" } }, "syslogFilterProcess": { "type": "array", "items": { "type": "string" } }, "syslogFilterSeverity": { "type": "array", "items": { "type": "string" } }, "syslogFilterHost": { "type": "array", "items": { "type": "string" } }, "syslogFilterMessage": { "type": "array", "items": { "type": "string" } }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "CreatorSyslogRequest": { "required": [ "isSyslogEnabled", "isSyslogArchive", "isSyslogForward", "syslogDhcpDiscover", "syslogDhcpOffer", "syslogDhcpAck", "syslogDhcpNak", "syslogDhcpRequest", "syslogDhcpInform", "syslogDhcpDecline", "syslogAuthAccess", "syslogAuthReject", "syslogOtpAccept", "syslogOtpAccess", "syslogOtpReject" ], "properties": { "isSyslogEnabled": { "description": "Is System logging enabled", "type": "boolean", "example": true }, "isSyslogArchive": { "description": "Are System logs archive", "type": "boolean", "example": true }, "isSyslogForward": { "description": "Is syslog forward", "type": "boolean", "example": true }, "syslogDhcpDiscover": { "type": "string" }, "syslogDhcpOffer": { "type": "string" }, "syslogDhcpAck": { "type": "string" }, "syslogDhcpNak": { "type": "string" }, "syslogDhcpRequest": { "type": "string" }, "syslogDhcpInform": { "type": "string" }, "syslogDhcpDecline": { "type": "string" }, "syslogAuthAccess": { "type": "string" }, "syslogAuthReject": { "type": "string" }, "syslogOtpAccept": { "type": "string" }, "syslogOtpAccess": { "type": "string" }, "syslogOtpReject": { "type": "string" }, "syslogHosts": { "type": "array", "items": { "type": "string" }, "nullable": true }, "syslogFilterProcess": { "type": "array", "items": { "type": "string" }, "nullable": true }, "syslogFilterSeverity": { "type": "array", "items": { "type": "string" }, "nullable": true }, "syslogFilterHost": { "type": "array", "items": { "type": "string" }, "nullable": true }, "syslogFilterMessage": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "ViewIndexesResponse": { "required": [ "id", "name", "state", "size", "isEnabled", "isBuiltIn", "category", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "state": { "type": "string" }, "size": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "category": { "$ref": "#/components/schemas/CategoryEnum" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewLogRotationConfigurationResponse": { "required": [ "authLogRotation", "accountingLogRotation", "sysLogRotation", "systemLogRotation", "dhcpLogRotation", "snmpLogRotation", "otpLogRotation", "tacacsLogRotation", "msEventsLogRotation" ], "properties": { "authLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "accountingLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "sysLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "systemLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "dhcpLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "snmpLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "otpLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "tacacsLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "msEventsLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "LogRotationConfigurationRequest": { "required": [ "authLogRotation", "accountingLogRotation", "sysLogRotation", "systemLogRotation", "dhcpLogRotation", "snmpLogRotation", "otpLogRotation", "tacacsLogRotation", "msEventsLogRotation" ], "properties": { "authLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "accountingLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "sysLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "systemLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "dhcpLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "snmpLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "otpLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "tacacsLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" }, "msEventsLogRotation": { "$ref": "#/components/schemas/LogRotationInterval" } }, "type": "object" }, "AuthEventAggregatedResponse": { "required": [ "access", "reject", "doNotResponse" ], "properties": { "access": { "type": "integer" }, "reject": { "type": "integer" }, "doNotResponse": { "type": "integer" } }, "type": "object" }, "AuthEventsCategoryAggregationResponse": { "required": [ "aggregations", "total" ], "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/AuthEventsCategoryAggregationItem" } }, "total": { "type": "integer" }, "data": { "type": "string", "nullable": true } }, "type": "object" }, "ListHistogramPolicyRequest": { "properties": { "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "ListDashboardMatrixPolicyResponse": { "required": [ "id", "name", "type", "countToday", "countYesterday" ], "properties": { "id": { "type": "integer" }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/MatrixType" }, "countToday": { "type": "integer" }, "countYesterday": { "type": "integer" }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "ssid": { "type": "string", "nullable": true } }, "type": "object" }, "ListEventsSyslogResponse": { "required": [ "id", "timestamp", "severity", "hostname", "rawMessage", "procid", "program", "fromhost", "message", "facility", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "severity": { "type": "string" }, "hostname": { "type": "string" }, "rawMessage": { "type": "string" }, "procid": { "type": "string" }, "program": { "type": "string" }, "fromhost": { "type": "string" }, "message": { "type": "string" }, "facility": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListEventsMseventsResponse": { "required": [ "id", "timestamp", "Status", "Category", "EventType", "Hostname", "LogonType", "SourceName", "Severity", "FullyQualifiedSubjectUserName", "Reason", "CalledStationID", "EventReceivedTime", "ClientName", "NASPortType", "CallingStationID", "EventID", "IpAddress", "TargetUserName", "TargetDomainName", "AuthenticationType", "AuthenticationPackageName", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "Status": { "type": "string" }, "Category": { "type": "string" }, "EventType": { "type": "string" }, "Hostname": { "type": "string" }, "LogonType": { "type": "string" }, "SourceName": { "type": "string" }, "Severity": { "type": "string" }, "FullyQualifiedSubjectUserName": { "type": "string" }, "Reason": { "type": "string" }, "CalledStationID": { "type": "string" }, "EventReceivedTime": { "type": "string" }, "ClientName": { "type": "string" }, "NASPortType": { "type": "string" }, "CallingStationID": { "type": "string" }, "EventID": { "type": "string" }, "IpAddress": { "type": "string" }, "TargetUserName": { "type": "string" }, "TargetDomainName": { "type": "string" }, "AuthenticationType": { "type": "string" }, "AuthenticationPackageName": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListEventsDhcpResponse": { "required": [ "id", "timestamp", "option161", "hostname", "vendorClassIdentifier", "gatewayIpAddress", "srcIpAddress", "clientHardwareAddress", "externalDhcp", "type", "poolIsFull", "yourIpAddress", "ipAddressLeaseTime", "isStatic", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "transactionId": { "type": "string", "nullable": true }, "option161": { "type": "string" }, "hostname": { "type": "string" }, "vendorClassIdentifier": { "type": "string" }, "gatewayIpAddress": { "type": "string" }, "srcIpAddress": { "type": "string" }, "clientHardwareAddress": { "type": "string" }, "externalDhcp": { "type": "string" }, "type": { "type": "string" }, "poolIsFull": { "type": "string" }, "yourIpAddress": { "type": "string" }, "ipAddressLeaseTime": { "type": "string" }, "isStatic": { "type": "boolean" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListEventsAuthorizeResponse": { "required": [ "id", "timestamp", "userMacAddress", "deviceType", "accessPointName", "type", "ssid", "nasMacAddress", "nasIpAddress", "auditSessionId", "parameterRequestList", "srcIpAddress", "username2", "reply", "returnAction", "eapType", "nasPort", "rejectReason", "cui", "nasPortId", "username", "vlanTag", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "userMacAddress": { "type": "string" }, "macAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMacAddressResponse" } ] }, "deviceType": { "type": "string" }, "accessPointName": { "type": "string" }, "type": { "type": "string" }, "ssid": { "type": "string" }, "nasMacAddress": { "type": "string" }, "nasIpAddress": { "type": "string" }, "auditSessionId": { "type": "string" }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "parameterRequestList": { "type": "string" }, "srcIpAddress": { "type": "string" }, "username2": { "type": "string" }, "reply": { "type": "string" }, "returnAction": { "type": "string" }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" } ] }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] }, "matrixPolicyRule": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" } ] }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "eapType": { "type": "string" }, "nasPort": { "type": "string" }, "rejectReason": { "type": "string" }, "cui": { "type": "string" }, "nasPortId": { "type": "string" }, "username": { "type": "string" }, "vlanTag": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListEventsAccountingResponse": { "required": [ "id", "timestamp", "userMacAddress", "sessionId", "nasPort", "type", "nasIdentifier", "auditSessionId", "parameterRequestList", "srcIpAddress", "userIpAddress", "username", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "userMacAddress": { "type": "string" }, "sessionId": { "type": "string" }, "nasPort": { "type": "string" }, "type": { "type": "string" }, "nasIdentifier": { "type": "string" }, "auditSessionId": { "type": "string" }, "parameterRequestList": { "type": "string" }, "srcIpAddress": { "type": "string" }, "userIpAddress": { "type": "string" }, "username": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewEventsSyslogResponse": { "required": [ "id", "timestamp", "severity", "hostname", "rawMessage", "procid", "program", "fromhost", "message", "facility" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "severity": { "type": "string" }, "hostname": { "type": "string" }, "rawMessage": { "type": "string" }, "procid": { "type": "string" }, "program": { "type": "string" }, "fromhost": { "type": "string" }, "message": { "type": "string" }, "facility": { "type": "string" } }, "type": "object" }, "ViewEventsMseventsResponse": { "required": [ "id", "timestamp", "Status", "Category", "EventType", "Hostname", "LogonType", "SourceName", "Severity", "FullyQualifiedSubjectUserName", "Reason", "CalledStationID", "EventReceivedTime", "ClientName", "NASPortType", "CallingStationID", "EventID", "IpAddress", "TargetUserName", "TargetDomainName", "AuthenticationType", "AuthenticationPackageName" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "Status": { "type": "string" }, "Category": { "type": "string" }, "EventType": { "type": "string" }, "Hostname": { "type": "string" }, "LogonType": { "type": "string" }, "SourceName": { "type": "string" }, "Severity": { "type": "string" }, "FullyQualifiedSubjectUserName": { "type": "string" }, "Reason": { "type": "string" }, "CalledStationID": { "type": "string" }, "EventReceivedTime": { "type": "string" }, "ClientName": { "type": "string" }, "NASPortType": { "type": "string" }, "CallingStationID": { "type": "string" }, "EventID": { "type": "string" }, "IpAddress": { "type": "string" }, "TargetUserName": { "type": "string" }, "TargetDomainName": { "type": "string" }, "AuthenticationType": { "type": "string" }, "AuthenticationPackageName": { "type": "string" } }, "type": "object" }, "ViewEventsDhcpResponse": { "required": [ "id", "timestamp", "option161", "hostname", "vendorClassIdentifier", "gatewayIpAddress", "srcIpAddress", "clientHardwareAddress", "parameterReply", "externalDhcp", "type", "parameterRequest", "poolIsFull", "yourIpAddress", "ipAddressLeaseTime", "isStatic" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "transactionId": { "type": "string", "nullable": true }, "option161": { "type": "string" }, "hostname": { "type": "string" }, "vendorClassIdentifier": { "type": "string" }, "gatewayIpAddress": { "type": "string" }, "srcIpAddress": { "type": "string" }, "clientHardwareAddress": { "type": "string" }, "parameterReply": { "type": "string" }, "externalDhcp": { "type": "string" }, "type": { "type": "string" }, "parameterRequest": { "type": "string" }, "poolIsFull": { "type": "string" }, "yourIpAddress": { "type": "string" }, "ipAddressLeaseTime": { "type": "string" }, "isStatic": { "type": "boolean" } }, "type": "object" }, "ViewEventsAuthorizeResponse": { "required": [ "id", "timestamp", "userMacAddress", "deviceType", "accessPointName", "type", "ssid", "nasMacAddress", "nasIpAddress", "auditSessionId", "parameterRequestList", "srcIpAddress", "username2", "reply", "returnAction", "parameterRequest", "eapType", "parameterReply", "nasPort", "rejectReason", "cui", "nasPortId", "username", "vlanTag" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "userMacAddress": { "type": "string" }, "macAddress": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMacAddressResponse" } ] }, "deviceType": { "type": "string" }, "accessPointName": { "type": "string" }, "type": { "type": "string" }, "ssid": { "type": "string" }, "nasMacAddress": { "type": "string" }, "nasIpAddress": { "type": "string" }, "auditSessionId": { "type": "string" }, "vlan": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListVlanResponse" } ] }, "parameterRequestList": { "type": "string" }, "srcIpAddress": { "type": "string" }, "networkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "username2": { "type": "string" }, "reply": { "type": "string" }, "returnAction": { "type": "string" }, "parameterRequest": { "type": "string" }, "endpointDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListEndpointDeviceResponse" } ] }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] }, "matrixPolicyRule": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" } ] }, "identity": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListIdentityResponse" } ] }, "eapType": { "type": "string" }, "parameterReply": { "type": "string" }, "nasPort": { "type": "string" }, "rejectReason": { "type": "string" }, "cui": { "type": "string" }, "nasPortId": { "type": "string" }, "username": { "type": "string" }, "vlanTag": { "type": "string" } }, "type": "object" }, "ViewEventsAccountingResponse": { "required": [ "id", "timestamp", "userMacAddress", "parameterReply", "sessionId", "nasPort", "type", "nasIdentifier", "auditSessionId", "parameterRequestList", "srcIpAddress", "userIpAddress", "parameterRequest", "username" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "userMacAddress": { "type": "string" }, "parameterReply": { "type": "string" }, "sessionId": { "type": "string" }, "nasPort": { "type": "string" }, "type": { "type": "string" }, "nasIdentifier": { "type": "string" }, "auditSessionId": { "type": "string" }, "parameterRequestList": { "type": "string" }, "srcIpAddress": { "type": "string" }, "networkDevice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListNetworkDeviceResponse" } ] }, "userIpAddress": { "type": "string" }, "parameterRequest": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "ListEventsTacacsResponse": { "required": [ "id", "timestamp", "nasIpAddress", "srcIpAddress", "access", "cmd", "login", "message", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "nasIpAddress": { "type": "string" }, "srcIpAddress": { "type": "string" }, "access": { "type": "string" }, "cmd": { "type": "string" }, "login": { "type": "string" }, "message": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListEventsSnmptrapResponse": { "required": [ "id", "timestamp", "srcIpAddress", "message", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "srcIpAddress": { "type": "string" }, "message": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ListEventsOtpResponse": { "required": [ "id", "timestamp", "ipv6Address", "ipAddress", "message", "type", "nasIpAddress", "srcIpAddress", "userIpAddress", "username", "accessType" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "transactionId": { "type": "string", "nullable": true }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] }, "matrixPolicyRule": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" } ] }, "ipv6Address": { "type": "string" }, "ipAddress": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "nasIpAddress": { "type": "string" }, "srcIpAddress": { "type": "string" }, "userIpAddress": { "type": "string" }, "username": { "type": "string" }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewEventsTacacsResponse": { "required": [ "id", "timestamp", "nasIpAddress", "srcIpAddress", "access", "cmd", "login", "message", "parameterReply", "parameterRequest" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "nasIpAddress": { "type": "string" }, "srcIpAddress": { "type": "string" }, "access": { "type": "string" }, "cmd": { "type": "string" }, "login": { "type": "string" }, "message": { "type": "string" }, "parameterReply": { "type": "string" }, "parameterRequest": { "type": "string" } }, "type": "object" }, "ViewEventsSnmptrapResponse": { "required": [ "id", "timestamp", "srcIpAddress", "message" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "srcIpAddress": { "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "ViewEventsOtpResponse": { "required": [ "id", "timestamp", "ipv6Address", "parameterReply", "ipAddress", "message", "type", "nasIpAddress", "srcIpAddress", "userIpAddress", "parameterRequest", "username" ], "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "transactionId": { "type": "string", "nullable": true }, "matrixPolicyCategory": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyCategoryResponse" } ] }, "matrixPolicyRule": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListMatrixPolicyRuleResponse" } ] }, "ipv6Address": { "type": "string" }, "parameterReply": { "type": "string" }, "ipAddress": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "nasIpAddress": { "type": "string" }, "srcIpAddress": { "type": "string" }, "userIpAddress": { "type": "string" }, "parameterRequest": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "ListIndexesResponse": { "required": [ "id", "name", "state", "size", "isEnabled", "isBuiltIn", "createdAt", "category", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "state": { "$ref": "#/components/schemas/IndexesStateEnum" }, "size": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isBuiltIn": { "type": "boolean" }, "createdAt": { "type": "string" }, "category": { "$ref": "#/components/schemas/CategoryEnum" }, "updatedAt": { "type": "string", "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "ViewCreatorBackupResponse": { "required": [ "isEnabled", "protocol", "remoteHost", "remotePath", "remoteUsername", "remotePassword", "remoteSecret", "isBackupRotate" ], "properties": { "isEnabled": { "type": "boolean" }, "protocol": { "$ref": "#/components/schemas/BackupProtocol" }, "protocolVersion": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmbProtocolVersion" } ] }, "remoteHost": { "type": "string" }, "remotePath": { "type": "string" }, "remoteUsername": { "type": "string" }, "remotePassword": { "type": "string" }, "remoteSecret": { "type": "string" }, "isBackupRotate": { "type": "boolean" }, "backupInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BackupInterval" } ] }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "CreatorBackupRequest": { "required": [ "isEnabled", "protocol", "remoteHost", "remotePath", "remoteUsername", "remotePassword", "remoteSecret", "isBackupRotate" ], "properties": { "isEnabled": { "description": "Is backup enabled", "type": "boolean", "example": true }, "protocol": { "$ref": "#/components/schemas/BackupProtocol" }, "protocolVersion": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmbProtocolVersion" } ] }, "remoteHost": { "type": "string", "maxLength": 255 }, "remotePath": { "type": "string", "maxLength": 255 }, "remoteUsername": { "type": "string", "maxLength": 255 }, "remotePassword": { "type": "string", "maxLength": 255, "minLength": 8 }, "remoteSecret": { "type": "string", "maxLength": 255 }, "isBackupRotate": { "description": "Is backup rotate", "type": "boolean", "example": true }, "backupInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BackupInterval" } ] } }, "type": "object" }, "ViewCreatorDisasterRecoveryResponse": { "required": [ "isEnabled" ], "properties": { "isEnabled": { "type": "boolean" }, "remoteHost": { "type": "string", "nullable": true }, "remoteToken": { "type": "string", "nullable": true }, "interval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DisasterRecoveryInterval" } ] }, "updatedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "CreatorDisasterRecoveryRequest": { "required": [ "isEnabled", "remoteHost", "remoteToken" ], "properties": { "isEnabled": { "type": "boolean" }, "remoteHost": { "type": "string", "maxLength": 255 }, "remoteToken": { "type": "string", "maxLength": 255 }, "interval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DisasterRecoveryInterval" } ] } }, "type": "object" }, "SystemLicenseRequestRequest": { "required": [ "licenseType" ], "properties": { "licenseType": { "$ref": "#/components/schemas/SystemLicenseType" }, "clientName": { "description": "Client name", "type": "string", "maxLength": 255, "example": "NACVIEW", "nullable": true }, "clientEmail": { "description": "Client email", "type": "string", "format": "email", "maxLength": 255, "example": "support@nacview.com", "nullable": true }, "clientPhone": { "description": "Client phone number", "type": "string", "maxLength": 20, "example": "+48610000000", "nullable": true }, "clientNip": { "description": "Client NIP number", "type": "string", "maxLength": 32, "example": "1234567890", "nullable": true }, "clientAddressCountry": { "description": "Country", "type": "string", "maxLength": 255, "example": "Poland", "nullable": true }, "clientAddressRegion": { "description": "Region / province", "type": "string", "maxLength": 255, "example": "Wielkopolska", "nullable": true }, "clientAddressCity": { "description": "City", "type": "string", "maxLength": 255, "example": "Pozna\u0144", "nullable": true }, "clientAddressCode": { "description": "Postal code", "type": "string", "maxLength": 16, "example": "61-142", "nullable": true }, "clientAddressStreet": { "description": "Street address", "type": "string", "maxLength": 255, "example": "Marceli\u0144ska 14", "nullable": true }, "clientItName": { "description": "IT contact person name", "type": "string", "maxLength": 255, "example": "Jan Kowalski", "nullable": true }, "clientItEmail": { "description": "IT contact email", "type": "string", "format": "email", "maxLength": 255, "example": "admin@nacview.com", "nullable": true }, "clientItPhone": { "description": "IT contact phone number", "type": "string", "maxLength": 20, "example": "+48612345678", "nullable": true } }, "type": "object" }, "NewSystemNodeRequest": { "required": [ "name", "sector" ], "properties": { "name": { "description": "Name of system node", "type": "string", "maxLength": 255, "example": "SystemNode A" }, "description": { "description": "description of system node", "type": "string", "maxLength": 4096, "example": "Device example 1 description", "nullable": true }, "sector": { "$ref": "#/components/schemas/NestedIdentifier" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewSystemNodeResponse": { "required": [ "accessType", "id", "name", "code", "status", "types", "isBuiltIn", "isRemoteVrrpEnabled", "sector", "createdAt", "isRebuildConfigRequired" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "code": { "type": "integer" }, "status": { "$ref": "#/components/schemas/SystemNodeStatus" }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/SystemNodeType" } }, "isBuiltIn": { "type": "boolean" }, "isRemoteVrrpEnabled": { "type": "boolean" }, "remoteVrrpIp": { "type": "string", "nullable": true }, "remoteVrrpMasterIp": { "type": "string", "nullable": true }, "remoteVrrpSlaveIp": { "type": "string", "nullable": true }, "remoteVrrpCidr": { "type": "integer", "nullable": true }, "remoteVrrpNodeId": { "type": "integer", "nullable": true }, "sector": { "$ref": "#/components/schemas/MiniListSectorResponse" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "systemNodeInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "systemNodeFirewalls": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" }, "nullable": true }, "systemNodeRoutings": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeRoutingResponse" }, "nullable": true }, "isRebuildConfigRequired": { "type": "boolean" }, "version": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "EditSystemNodeRequest": { "required": [ "name", "sector" ], "properties": { "name": { "description": "Name of system node", "type": "string", "maxLength": 255, "example": "My node" }, "description": { "description": "Description", "type": "string", "maxLength": 4096, "example": "My custom description", "nullable": true }, "sector": { "$ref": "#/components/schemas/NestedIdentifier" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "systemNodeFirewalls": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "systemNodeRoutings": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "RefreshConfigurationSystemNodeRequest": { "properties": { "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ReplicationSystemNodeDbRequest": { "properties": { "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ConfirmUpgradeResponse": { "required": [ "isAllowed", "message" ], "properties": { "isAllowed": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "UpgradeSlaveSystemNode": { "properties": { "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "SystemNodeFirewallRequest": { "required": [ "name", "value", "isEnabled", "type" ], "properties": { "name": { "description": "name of the device credentials", "type": "string", "maxLength": 255, "example": "Device example 1" }, "value": { "description": "value of firewall rule", "type": "integer", "example": 2 }, "isEnabled": { "type": "boolean" }, "description": { "description": "description of the device credentials", "type": "string", "maxLength": 4096, "example": "Device example 1 description", "nullable": true }, "type": { "$ref": "#/components/schemas/FirewallType" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewSystemNodeFirewallResponse": { "required": [ "accessType", "id", "name", "isEnabled", "value", "createdAt" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FirewallType" } ] }, "value": { "type": "integer" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "nullable": true }, "systemNodeInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true } }, "type": "object" }, "SystemNodeInterfaceRequest": { "required": [ "name", "ip", "cidr" ], "properties": { "name": { "description": "name of the device credentials", "type": "integer", "maximum": 4094, "minimum": 2, "example": 42 }, "description": { "description": "description of the device credentials", "type": "string", "maxLength": 4096, "example": "Device example 1 description", "nullable": true }, "ip": { "description": "IP address", "type": "string", "maxLength": 50, "example": "127.0.0.1" }, "cidr": { "description": "Netmask", "type": "integer", "maximum": 30, "minimum": 16, "example": 24 }, "isEnabled": { "description": "Is active", "type": "boolean", "default": false, "example": false }, "isRemoteVrrpEnabled": { "description": "Can connect", "type": "boolean", "default": false, "example": true }, "remoteVrrpIp": { "description": "Virtual Router Redundancy Protocol IP", "type": "string", "maxLength": 50, "example": "168.1.13.1", "nullable": true }, "remoteVrrpCidr": { "description": "remoteVrrpCidr", "type": "integer", "maximum": 30, "minimum": 16, "example": 24, "nullable": true }, "systemNodeFirewalls": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "systemNodeRoutings": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "disabledServices": { "type": "array", "items": { "$ref": "#/components/schemas/SystemNodeService" }, "nullable": true } }, "type": "object" }, "ViewSystemNodeInterfaceResponse": { "required": [ "accessType", "id", "name", "isEnabled", "isRemoteVrrpEnabled", "createdAt", "disabledServices" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "cidr": { "type": "integer", "nullable": true }, "isRemoteVrrpEnabled": { "type": "boolean" }, "remoteVrrpIp": { "type": "string", "nullable": true }, "remoteVrrpCidr": { "type": "integer", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "disabledServices": { "type": "array", "items": { "$ref": "#/components/schemas/SystemNodeService" } }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "systemNodeFirewalls": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeFirewallResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "systemNodeRoutings": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeRoutingResponse" }, "nullable": true } }, "type": "object" }, "SystemNodeRoutingRequest": { "required": [ "name", "nextIpAddress" ], "properties": { "name": { "description": "name of the routing", "type": "string", "maxLength": 255, "example": "Device example 1" }, "description": { "description": "description of the device credentials", "type": "string", "maxLength": 4096, "example": "Routing description", "nullable": true }, "nextIpAddress": { "description": "IP address", "type": "string", "maxLength": 50, "example": "127.0.0.1" }, "isEnabled": { "description": "Is active", "type": "boolean", "default": false, "example": false }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true } }, "type": "object" }, "ViewSystemNodeRoutingResponse": { "required": [ "accessType", "id", "name", "nextIpAddress", "isEnabled", "createdAt" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "nextIpAddress": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "nullable": true }, "systemNodeInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true } }, "type": "object" }, "SystemNodeStatusResponse": { "required": [ "nodes" ], "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/SystemNodeStatusDetails" } } }, "type": "object" }, "VrrpSystemNodeRequest": { "required": [ "name", "remoteIp", "remoteMasterIp", "remoteSlaveIp", "remoteCidr" ], "properties": { "name": { "description": "Name of system node", "type": "string", "maxLength": 255, "example": "SystemNode A" }, "remoteIp": { "description": "Remote IP of vrrp", "type": "string", "maxLength": 50, "example": "192.168.12.3" }, "remoteMasterIp": { "description": "Remote master IP", "type": "string", "maxLength": 50, "example": "10.10.20.151" }, "remoteSlaveIp": { "description": "Remote slave IP", "type": "string", "maxLength": 50, "example": "10.10.20.152" }, "remoteCidr": { "description": "Cidr number", "type": "integer", "maximum": 30, "minimum": 16, "example": 30 }, "isEnabled": { "description": "remote service active", "type": "boolean", "default": false, "example": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/NestedIdentifier" }, "nullable": true }, "masterSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] }, "slaveSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/NestedIdentifier" } ] } }, "type": "object" }, "ViewVrrpSystemNodeResponse": { "required": [ "accessType", "id", "remoteIp", "name", "remoteMasterIp", "remoteSlaveIp", "remoteCidr", "isEnabled" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "remoteIp": { "type": "string" }, "name": { "type": "string" }, "remoteMasterIp": { "type": "string" }, "remoteSlaveIp": { "type": "string" }, "remoteCidr": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "slaveSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "masterSystemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true } }, "type": "object" }, "ViewSystemLicenseResponse": { "required": [ "name", "type", "validFrom", "clientLimit", "currentUsage", "todayMaximumUsage", "licenseNumber", "licenseData" ], "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/SystemLicenseType" }, "validFrom": { "type": "string" }, "validTo": { "type": "string", "nullable": true }, "clientLimit": { "type": "integer" }, "currentUsage": { "type": "integer" }, "todayMaximumUsage": { "type": "integer" }, "licenseNumber": { "type": "string" }, "licenseData": { "type": "object", "additionalProperties": {} } }, "type": "object" }, "HourlyLicenseUsageResponse": { "required": [ "index", "createdAt", "usersCurrent", "usersMax", "macsCurrent", "macsMax" ], "properties": { "index": { "type": "integer" }, "createdAt": { "type": "string" }, "usersCurrent": { "type": "integer" }, "usersMax": { "type": "integer" }, "macsCurrent": { "type": "integer" }, "macsMax": { "type": "integer" } }, "type": "object" }, "DailyLicenseUsageResponse": { "required": [ "index", "createdAt", "users", "macs" ], "properties": { "index": { "type": "integer" }, "createdAt": { "type": "string" }, "users": { "type": "integer" }, "macs": { "type": "integer" } }, "type": "object" }, "MonthlyLicenseSummaryResponse": { "required": [ "monthsValidity", "isLimited" ], "properties": { "monthsValidity": { "type": "array", "items": {} }, "isLimited": { "type": "boolean" } }, "type": "object" }, "PreviewEncryptedLicenseResponse": { "required": [ "content", "private" ], "properties": { "content": { "type": "object", "additionalProperties": {} }, "private": { "type": "object", "additionalProperties": {} } }, "type": "object" }, "ListSystemNodeFirewallResponse": { "required": [ "id", "name", "isEnabled", "value", "createdAt", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FirewallType" } ] }, "value": { "type": "integer" }, "createdAt": { "type": "string" }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "nullable": true }, "systemNodeInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListSystemNodeFirewallResponse": { "required": [ "id", "name", "isEnabled", "type" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/FirewallType" } }, "type": "object" }, "ListSystemNodeInterfaceResponse": { "required": [ "id", "name", "isEnabled", "isRemoteVrrpEnabled", "createdAt", "disabledServices", "accessType" ], "properties": { "id": { "type": "integer" }, "name": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "cidr": { "type": "integer", "nullable": true }, "isRemoteVrrpEnabled": { "type": "boolean" }, "remoteVrrpIp": { "type": "string", "nullable": true }, "remoteVrrpCidr": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "disabledServices": { "type": "array", "items": { "$ref": "#/components/schemas/SystemNodeService" } }, "systemNode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] }, "systemNodeFirewalls": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeFirewallResponse" }, "nullable": true }, "systemNodeRoutings": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeRoutingResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] } }, "type": "object" }, "MiniListSystemNodeInterfaceResponse": { "required": [ "id", "name", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "systemNode": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSystemNodeResponse" } ] } }, "type": "object" }, "SystemNodeGraphListResponse": { "required": [ "deviceGraphId", "systemNodeId", "graph", "enabled" ], "properties": { "deviceGraphId": { "type": "integer" }, "systemNodeId": { "type": "integer" }, "graph": { "type": "string" }, "enabled": { "type": "boolean" } }, "type": "object" }, "ListSystemNodeResponse": { "required": [ "accessType", "id", "name", "code", "status", "types", "isBuiltIn", "isRemoteVrrpEnabled", "isRebuildConfigRequired" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "code": { "type": "integer" }, "status": { "$ref": "#/components/schemas/SystemNodeStatus" }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/SystemNodeType" } }, "sector": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSectorResponse" } ] }, "isBuiltIn": { "type": "boolean" }, "isRemoteVrrpEnabled": { "type": "boolean" }, "remoteVrrpIp": { "type": "string", "nullable": true }, "remoteVrrpMasterIp": { "type": "string", "nullable": true }, "remoteVrrpSlaveIp": { "type": "string", "nullable": true }, "remoteVrrpCidr": { "type": "integer", "nullable": true }, "remoteVrrpNodeId": { "type": "integer", "nullable": true }, "systemNodeInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" }, "nullable": true }, "systemNodeFirewalls": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeFirewallResponse" }, "nullable": true }, "systemNodeRoutings": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeRoutingResponse" }, "nullable": true }, "isRebuildConfigRequired": { "type": "boolean" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true }, "version": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "MiniListSystemNodeResponse": { "required": [ "id", "name", "code" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "integer" }, "sector": { "default": null, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MiniListSectorResponse" } ] }, "version": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "ConfigurationSystemNodeRequest": { "required": [ "encryptionKey" ], "properties": { "encryptionKey": { "description": "Key that will be used for encryption", "type": "string" } }, "type": "object" }, "ListSystemNodeRoutingResponse": { "required": [ "accessType", "id", "name", "nextIpAddress", "isEnabled", "createdAt" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "nextIpAddress": { "type": "string" }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "systemNodes": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeResponse" }, "nullable": true }, "systemNodeInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListSystemNodeInterfaceResponse" }, "nullable": true }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true } }, "type": "object" }, "MiniListSystemNodeRoutingResponse": { "required": [ "id", "name", "nextIpAddress", "isEnabled" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "nextIpAddress": { "type": "string" }, "isEnabled": { "type": "boolean" } }, "type": "object" }, "CountInfoOfSystemNodeStatusResponse": { "required": [ "errorsNumber", "warningsNumber" ], "properties": { "errorsNumber": { "type": "integer" }, "warningsNumber": { "type": "integer" } }, "type": "object" }, "ListVrrpSystemNodeResponse": { "required": [ "accessType", "id", "name", "remoteIp", "isEnabled" ], "properties": { "accessType": { "type": "array", "items": { "type": "string" }, "example": [ "EDIT", "VIEW", "DELETE", "CUSTOM" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "remoteIp": { "type": "string" }, "isEnabled": { "type": "boolean" }, "accessGroups": { "type": "array", "items": { "$ref": "#/components/schemas/MiniListAccessGroupResponse" }, "nullable": true } }, "type": "object" }, "TftpNewDirectoryRequest": { "required": [ "path" ], "properties": { "path": { "description": "Path to create directory in tftp server", "type": "string", "maxLength": 255, "example": "/root/test/new-dir" } }, "type": "object" }, "TftpRemoveItemRequest": { "required": [ "path" ], "properties": { "path": { "description": "path item to remove", "type": "string", "maxLength": 255, "example": "/root/test.txt" } }, "type": "object" }, "TftpFileUploadRequest": { "required": [ "path", "file" ], "properties": { "path": { "description": "path of dir", "type": "string", "example": "/root/test" }, "file": { "description": "$file", "type": "string" } }, "type": "object" }, "TftpDownloadFileRequest": { "required": [ "path" ], "properties": { "path": { "description": "path to file", "type": "string", "maxLength": 255, "example": "/root/file.txt" } }, "type": "object" }, "TftpDirContentRequest": { "required": [ "path" ], "properties": { "path": { "description": "path of dir", "type": "string", "example": "/root/test" } }, "type": "object" }, "FileContentResponse": { "required": [ "name", "size", "lastModified" ], "properties": { "name": { "type": "string" }, "size": { "type": "integer" }, "lastModified": { "type": "string" } }, "type": "object" }, "CollectionActionType": { "type": "string", "enum": [ "add", "remove" ] }, "NestedIdentifier": { "required": [ "id" ], "properties": { "id": { "type": "integer" } }, "type": "object" }, "HttpExceptionMessageCodeEnum": { "type": "string", "enum": [ "public_server_certificate_not_found", "file_is_not_valid_certificate", "too_many_certificates", "certificate_is_corrupt", "failed_to_parsing_private_server_key", "missing_object", "bad_tls_version", "cannot_generate_csr", "can_not_sign_csr", "could_not_translate", "can_not_parse_certificate", "invalid_country_code", "missing_ca_certificate", "missing_private_certificate", "missing_csr", "missing_interval_duration", "not_found_config_file", "invalid_digest_algorithm", "invalid_subject_alternative_name_format", "scep_configuration_invalid", "not_authorized", "incorrect_username_or_password", "resource_not_exists", "object_cant_be_enabled_or_disabled", "invalid_user_credentials", "cant_remove_yourself", "invalid_reset_password_credentials", "incorrect_main_user_roles", "password_policy_incompliant", "password_cannot_be_set_for_authorization_server", "tacacs_password_cannot_be_set_for_authorization_server", "expiry_date_is_not_valid", "no_permission_found_for_method", "no_permission_found_for_route", "no_permission_to_this_area", "problem_with_provider", "invalid_credentials", "hash_unknown_type", "bad_configuration_for_identity_purpose", "bad_purpose_for_objects", "found_unexpected_object_number", "invalid_mac_address", "cannot_receive_oui", "only_one_ip_per_subnetwork", "missing_template_key", "provide_illegal_key", "not_empty_variable", "directory_already_exists", "file_not_found", "default_dir_removing", "file_already_exists", "not_found_redis_connection", "cant_connect_to_redis", "null_service_type", "not_found_provider", "raw_message_or_template_type_required", "send_sms_failed", "empty_host", "unsupported_ip_address_type", "invalid_cidr", "subnetwork_collision", "same_subnetwork_collision", "ip_is_not_the_subnetwork_start", "invalid_request", "missing_values_for_given_type", "object_group_cannot_be_assign_to_dhcp_option", "invalid_system_node", "cannot_delete_system_node", "wrong_version", "slave_node_already_assigned_to_vrrp", "master_node_already_assigned_to_vrrp", "missing_initial_configuration", "object_not_found", "object_is_built_in", "validator_data_exception", "object_must_be_enabled", "not_found_keys", "not_found_method", "empty_data", "nested_object_filters_only_on_selected_fields", "at_least_one_select_expected", "missing_password_configuration", "access_denied", "object_with_that_value_already_exist", "invalid_authorization_server_type", "ip_address_already_assigned", "object_group_voucher_type_assignment_missing_exception", "password_cannot_be_changed_for_this_authorization_server", "unable_to_print_identity", "identity_not_found_for_password_reset", "invalid_identity_reset_password_credentials", "invalid_identity_credentials", "missing_identity_email", "cannot_remove_active_policy", "duplicated_configuration_for_object_group", "cannot_find_response", "cannot_modify_deleted_rule", "cannot_delete_active_rule", "invalid_snmp_disconnect_timeout", "ip_address_outside_subnetwork_range", "grpc_call_failed", "dhcp_group_bad_purpose", "invalid_date", "cannot_delete", "invalid_category", "invalid_integration_server_config_for_given_type", "monitoring_not_enabled", "monitoring_already_registered", "ip_address_missing_subnetwork", "ip_address_cannot_be_gateway_for_this_subnetwork", "violation_of_uniqueness_for_ip_address", "captive_portal_missing_required_sponsor", "captive_portal_cannot_create_device", "identity_email_is_already_in_use", "identity_email_is_too_short", "captive_portal_sponsor_invalid_activation_link", "could_not_init_web_ssh", "missing_license_data_exception", "invalid_license_file_exception", "invalid_license_payload_exception", "license_client_has_been_blocked", "no_required_license", "could_not_connect", "already_up_to_date", "inactive_licence", "do_not_have_permission_to_update", "slave_version_has_master_version", "backup_cannot_be_delivered", "mfa_email_token_too_fresh_to_send_new_one", "cannot_generate_qr_code", "deletion_conflict", "string_expected", "int_expected", "bool_expected", "flout_expected", "unknow_type", "invalid_percentage_range", "invalid_csv_headers", "unsupported_import_field", "import_config_missing_fields", "import_csv_file_unreadable", "import_csv_invalid", "import_file_persist_failed", "import_invalid_file_payload" ] }, "OperationSystem": { "type": "string", "enum": [ "WINDOWS", "IOS", "ANDROID", "MACOS", "LINUX" ] }, "NacviewAssistantType": { "type": "string", "enum": [ "PEAP", "TLS" ] }, "PasswordConfigurationPolicyEnum": { "type": "string", "enum": [ "NO_VALIDATION", "LETTER_DIGIT", "LETTER_DIGIT_UPPER", "LETTER_DIGIT_UPPER_SPECIAL" ] }, "PasswordConfigurationForceChangeIntervalEnum": { "type": "string", "enum": [ "P1M", "P2M", "P3M", "P6M", "P1Y" ] }, "MfaType": { "type": "string", "enum": [ "GOOGLE_AUTHENTICATOR", "NACVIEW_AUTHENTICATOR", "SMS", "YUBIKEY", "EMAIL" ] }, "OsType": { "type": "string", "enum": [ "windows_10", "windows_7", "android", "LINUX", "IOS", "MACOS" ] }, "PermissionsRouterValidatorRequest": { "required": [ "resourceRoute", "permissionLevel", "accessType" ], "properties": { "resourceRoute": { "$ref": "#/components/schemas/ResourceRouteEnum" }, "permissionLevel": { "description": "0 - no access, 1 - full access , 2 - partial access", "type": "integer", "enum": [ 0, 1, 2 ], "example": 1 }, "accessType": { "description": "Access type: VIEW, LIST, EDIT, DELETE, CREATE, CUSTOM", "type": "string", "enum": [ "VIEW", "LIST", "EDIT", "DELETE", "CREATE", "CUSTOM" ], "example": "LIST" } }, "type": "object" }, "PermissionRouterResponse": { "required": [ "resourceRoute", "accessType", "permissionLevel" ], "properties": { "resourceRoute": { "type": "string" }, "accessType": { "type": "string" }, "permissionLevel": { "type": "integer" } }, "type": "object" }, "MatrixType": { "type": "string", "enum": [ "NETWORK", "VPN" ] }, "DynamicValue": { "type": "string", "enum": [ "MAC_CUSTOM1", "MAC_CUSTOM2", "MAC_CUSTOM3", "MAC_CUSTOM4", "ENDPOINT_CUSTOM1", "ENDPOINT_CUSTOM2", "ENDPOINT_CUSTOM3", "ENDPOINT_CUSTOM4", "IDENTITIE_CUSTOM1", "IDENTITIE_CUSTOM2", "IDENTITIE_CUSTOM3", "IDENTITIE_CUSTOM4" ] }, "DhcpOptionOperator": { "type": "string", "enum": [ "=", ":=", "+=", "^=", "-=", "==", "!=", ">", ">=", "<", "<=", "=~", "!~", "!*" ] }, "MatrixPolicyProfileActionType": { "type": "string", "enum": [ "NETWORK", "VPN" ] }, "ActionType": { "type": "string", "enum": [ "EMAIL", "SMS", "SNMP", "DHCP", "NMAP", "WEBHOOK", "SYSLOG", "SCRIPT" ] }, "BlockedTimeout": { "type": "string", "enum": [ "PT1H", "PT2H", "PT12H", "P1D", "P3D", "P7D", "P14D", "P1M" ] }, "HttpType": { "type": "string", "enum": [ "GET", "POST" ] }, "ObjectType": { "type": "string", "enum": [ "USER", "HOST", "TEAP" ] }, "MethodTypes": { "type": "string", "enum": [ "TLS", "PEAP", "MSCHAP", "FAST", "GTC", "PAP", "CHAP", "TTLS_TLS", "TTLS_PAP", "TTLS_CHAP", "TTLS_MSCHAP", "MAB", "TEAP_USER", "TEAP_HOST" ] }, "ActionType2": { "type": "string", "enum": [ "ACCESS", "REJECT", "NO_RESPONSE" ] }, "VpnVerificationType": { "type": "string", "enum": [ "NONE", "SMS_TOKEN", "GOOGLE_AUTH", "NACVIEW_AUTH", "YUBIKEY_AUTH" ] }, "VpnType": { "type": "string", "enum": [ "PAP", "MSCHAP" ] }, "WeekDays": { "type": "string", "enum": [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ] }, "TestMatrixType": { "type": "string", "enum": [ "IDENTITY", "ENDPOINT_DEVICE" ] }, "MatrixPolicyIdentityMethodType": { "type": "string", "enum": [ "TLS", "PEAP", "MSCHAP", "FAST", "GTC", "PAP", "CHAP", "TTLS_TLS", "TTLS_PAP", "TTLS_CHAP", "TTLS_MSCHAP" ] }, "MatrixPolicyEndpointDeviceMethodType": { "type": "string", "enum": [ "TLS", "PEAP", "TTLS_TLS", "TTLS_MSCHAP", "MAB" ] }, "TestMatrixResponse": { "type": "string", "enum": [ "ACCESS", "REJECT", "DONOTRESPONSE" ] }, "AuthorizationServerPurposeEnum": { "type": "string", "enum": [ "USER", "IDENTITY", "ENDPOINT_DEVICE" ] }, "AuthorizationServerType": { "type": "string", "enum": [ "LOCAL", "EXTERNAL", "REDIRECT", "LDAP", "GSUITE", "SOCIAL_PORTAL", "INTEGRATION_SERVER", "RADIUS" ] }, "AuthorizationSeverDbDriverEnum": { "type": "string", "enum": [ "drizzle_pdo_mysql", "mysqli", "oci8", "pdo_mysql", "pdo_odbc", "pdo_pgsql", "pdo_mssql" ] }, "AuthorizationServerSocialPortalTypeEnum": { "type": "string", "enum": [ "FACEBOOK", "LINKEDIN", "GOOGLE" ] }, "AuthorizationServerRadiusAuthTypeEnum": { "type": "string", "enum": [ "PAP", "CHAP" ] }, "AuthorizationServerLoginType": { "type": "string", "enum": [ "mail", "sAMAccountName", "uid", "dnshostname", "userprincipalname", "displayname", "distinguishedname", "cn", "generationqualifier", "msDS-PrincipalName" ] }, "SynchronizationIntervalEnum": { "type": "string", "enum": [ "P1D", "P7D", "P1M" ] }, "RemoveObjectTimeEnum": { "type": "string", "enum": [ "P1M", "P3M", "P6M", "P1Y", "P3Y", "P5Y" ] }, "PasswordHashType": { "type": "string", "enum": [ "MD5", "SHA1", "SHA2", "SHA256", "SSHA512", "CRYPT", "BCRYPT", "NT_HASH", "text/plain" ] }, "EndpointType": { "type": "string", "enum": [ "DESKTOP", "NOTEBOOK", "PHONE", "PRINTER", "SERVER", "STORAGE", "HYPERVISOR", "IOT", "OT", "IP_CAMERA", "OTHER" ] }, "MiniListEndpointDeviceHandler": { "type": "object" }, "ViewIntegrationServerConfigResponse": { "properties": { "url": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "tenant": { "type": "string", "nullable": true }, "billingId": { "type": "string", "nullable": true }, "accessKey": { "type": "string", "nullable": true }, "applicationId": { "type": "string", "nullable": true }, "applicationVersion": { "type": "string", "nullable": true }, "deviceSpaceId": { "type": "string", "nullable": true }, "jsonFile": { "type": "string", "nullable": true } }, "type": "object" }, "IntegrationServerType": { "type": "string", "enum": [ "AIR_WATCH", "IBM_MAAS", "MOBILE_IRON", "MICROSOFT_INTUNE", "GSUITE", "PALO_ALTO", "CHECK_POINT", "FAMOC", "SERVICE_NOW", "FORTI_GATE", "ESET" ] }, "IntegrationServerConfigRequest": { "properties": { "url": { "description": "URL of Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "login": { "description": "Login to Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "password": { "description": "Password to Integration Server", "type": "string", "maxLength": 255, "minLength": 8, "nullable": true }, "secret": { "description": "Secret to Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "tenant": { "description": "Tenant to Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "billingId": { "description": "BillingId to Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "accessKey": { "description": "AccessKey to Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "applicationId": { "description": "ApplicationId of Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "applicationVersion": { "description": "ApplicationVersion", "type": "string", "maxLength": 255, "nullable": true }, "deviceSpaceId": { "description": "DeviceSpaceId in Integration Server", "type": "string", "maxLength": 255, "nullable": true }, "jsonFile": { "description": "JsonFile", "type": "string", "maxLength": 255, "nullable": true } }, "type": "object" }, "PriorityType": { "type": "string", "enum": [ "PERMIT", "DENY" ] }, "OtpType": { "type": "string", "enum": [ "NACVIEW_AUTHENTICATOR", "GOOGLE_AUTHENTICATOR", "YUBIKEY" ] }, "TacacsServerCustomParameterPurpose": { "type": "string", "enum": [ "tacacs", "radius" ] }, "SearchGroupType": { "type": "string", "enum": [ "ACCESS_GROUP", "OBJECT_GROUP" ] }, "OrganizationUnitsResult": { "required": [ "children" ], "properties": { "ou": { "title": "Generated from protobuf field string ou = 1;", "type": "string", "default": "" }, "dn": { "title": "Generated from protobuf field string dn = 2;", "type": "string", "default": "" }, "children": { "$ref": "#/components/schemas/RepeatedField" } }, "type": "object" }, "ObjectCertificateType": { "type": "string", "enum": [ "IDENTITY", "ENDPOINT_DEVICE", "WWW_SERVER" ] }, "CertificateDigestAlgorithmEnum": { "type": "string", "enum": [ "SHA1", "SHA256", "SHA384", "SHA512", "SHA3-256", "SHA3-384", "SHA3-512" ] }, "TeapMethodTypeEnum": { "type": "string", "enum": [ "NONE", "PEAP", "TLS" ] }, "EapMethodTypeEnum": { "type": "string", "enum": [ "MD5", "PEAP", "TLS", "GTC", "MSCHAPv2" ] }, "PkiTlsVersionEnum": { "type": "string", "enum": [ "1.0", "1.1", "1.2", "1.3" ] }, "CaView": { "properties": { "validTo": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "localityName": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "organizationalUnitName": { "type": "string", "nullable": true }, "certName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "CertChainViewResponse": { "required": [ "id", "name", "order", "isRoot", "validTo", "validFrom", "hierarchy", "createdAt", "serialNumber" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "order": { "type": "integer" }, "isRoot": { "type": "boolean" }, "validTo": { "type": "string" }, "validFrom": { "type": "string" }, "hierarchy": { "type": "integer" }, "createdAt": { "type": "string" }, "serialNumber": { "type": "string" }, "previousSerialNumber": { "type": "string", "nullable": true } }, "type": "object" }, "ServerCaView": { "properties": { "validTo": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "localityName": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "organizationalUnitName": { "type": "string", "nullable": true }, "certName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "subjectAlternativeName": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "CrlIntervalDuration": { "type": "string", "enum": [ "P1D", "P7D", "P1M" ] }, "CaView2": { "required": [ "name", "countryCode", "stateName", "locationName", "organizationName", "organizationalUnitName", "email", "challengeToken" ], "properties": { "name": { "type": "string" }, "validTo": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "countryCode": { "type": "string" }, "stateName": { "type": "string" }, "locationName": { "type": "string" }, "organizationName": { "type": "string" }, "organizationalUnitName": { "type": "string" }, "email": { "type": "string" }, "challengeToken": { "type": "string" } }, "type": "object" }, "ServerCaView2": { "required": [ "name", "validTo" ], "properties": { "name": { "type": "string" }, "validTo": { "type": "string" }, "validFrom": { "type": "string", "nullable": true }, "subjectAlternativeName": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "CertificateTypeEnum": { "type": "string", "enum": [ "INTERNAL", "EXTERNAL", "EXTERNAL_CSR" ] }, "CaView3": { "properties": { "validTo": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "localityName": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "organizationalUnitName": { "type": "string", "nullable": true }, "certName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "type": "object" }, "ServerCaView3": { "required": [ "name" ], "properties": { "name": { "type": "string" }, "validTo": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "localityName": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "organizationalUnitName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "subjectAlternativeName": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "InternalServerView": { "required": [ "name", "validTo" ], "properties": { "name": { "type": "string" }, "validTo": { "type": "string" }, "validFrom": { "type": "string", "nullable": true }, "subjectAlternativeName": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "RequestView": { "required": [ "name", "countryCode", "stateName", "localityName", "organizationName", "organizationalUnitName", "email" ], "properties": { "name": { "type": "string" }, "countryCode": { "type": "string" }, "stateName": { "type": "string" }, "localityName": { "type": "string" }, "organizationName": { "type": "string" }, "organizationalUnitName": { "type": "string" }, "email": { "type": "string" }, "subjectAlternativeName": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" }, "ImportStatus": { "type": "string", "enum": [ "import.status.draft", "import.status.parsed", "import.status.validated", "import.status.decisions_made", "import.status.completed", "import.status.error", "import.status.in_progress" ] }, "ImportObjectType": { "type": "string", "enum": [ "vlan", "identity", "endpoint-device", "subnetwork", "mac-address", "network-device" ] }, "ValidationStatusEnum": { "type": "string", "enum": [ "success", "warning", "error" ] }, "ImportValidationIssueResponse": { "required": [ "rowIndexes", "field", "message", "code", "severity" ], "properties": { "rowIndexes": { "type": "array", "items": { "type": "integer" } }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "value": { "type": "string", "nullable": true }, "severity": { "type": "string" } }, "type": "object" }, "MonitoringInterval": { "type": "integer", "enum": [ 1, 5, 15, 30, 60 ] }, "IpAddressType": { "type": "string", "enum": [ "NORMAL", "NETWORK", "GATEWAY", "BROADCAST" ] }, "IpAddressPurpose": { "type": "string", "enum": [ "STATIC", "RESERVED", "SERVICE", "DYNAMIC" ] }, "PurposeObjectGroupTypeEnum": { "type": "string", "enum": [ "port", "mac_address", "identity", "network_device", "endpoint_device", "ip_address" ] }, "ObjectGroupType": { "type": "string", "enum": [ "NORMAL", "QUARANTINE", "VOUCHER" ] }, "PortPurposeEnum": { "type": "string", "enum": [ "ACCESS", "UPLINK" ] }, "PortTypeEnum": { "type": "string", "enum": [ "ETHERNET", "FIBER" ] }, "PrintableTypeEnum": { "type": "string", "enum": [ "html_file_with_print", "pdf_file" ] }, "CaptivePortalValidity": { "type": "string", "enum": [ "PT4H", "PT8H", "PT12H", "P1D", "P2D", "P3D", "P5D", "P14D", "P1M", "P2M", "P3M", "P6M", "P1Y" ] }, "CaptivePortalPreferredLocale": { "type": "string", "enum": [ "PL", "GB", "DE", "FR", "UA", "ES", "EN" ] }, "CaptivePortalVerificationType": { "type": "string", "enum": [ "NACVIEW_AUTHENTICATOR", "GOOGLE_AUTHENTICATOR", "YUBIKEY", "SMS", "EMAIL" ] }, "CaptivePortalNotifyRegister": { "type": "string", "enum": [ "EMAIL", "INSTANT", "SMS" ] }, "CaptivePortalResetPasswordNotify": { "type": "string", "enum": [ "EMAIL", "SMS", "NACVIEW_AUTHENTICATOR", "GOOGLE_AUTHENTICATOR", "YUBIKEY" ] }, "CaptivePortalCodeRefresh": { "type": "string", "enum": [ "P1D", "P7D", "P1M" ] }, "CaptivePortalRegistrationFormType": { "type": "string", "enum": [ "TEXT", "SINGLE", "MULTI" ] }, "DestinationType": { "type": "string", "enum": [ "NACVIEW", "CAPTIVE_PORTAL" ] }, "LanguageType": { "type": "string", "enum": [ "PL", "EN", "DE" ] }, "UpdateProfilingDbInterval": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH" ] }, "ProfilingModule": { "type": "string", "enum": [ "SNMP", "TCP", "NMAP", "WMI", "WinRM", "DHCP Fingerprinting", "HTTP", "Vendor OUI", "CDP/LLDP", "LDAP", "DNS", "RADIUS" ] }, "ScoutStatus": { "type": "string", "enum": [ "NEW", "INITIALIZED", "ACCEPTED", "REJECTED" ] }, "ScoutOs": { "type": "string", "enum": [ "WIN", "MAC", "LINUX" ] }, "ScoutRight": { "type": "string", "enum": [ "USER", "ADMIN" ] }, "IdentitySchema": { "type": "string", "enum": [ "COUNTER", "DATE_AND_RANDOM", "RANDOM" ] }, "IdentityValidationInterval": { "type": "string", "enum": [ "PT4H", "PT8H", "PT12H", "P1D", "P2D", "P3D", "P5D", "P14D", "P1M", "P2M", "P3M", "P6M", "P1Y" ] }, "VoucherCleanInterval": { "type": "string", "enum": [ "P1D", "P7D", "P1M", "P3M", "P6M", "P1Y" ] }, "IdentityVoucherType": { "type": "string", "enum": [ "S4HOUR", "S8HOUR", "S12HOUR", "S1DAY", "S2DAYS", "S3DAYS", "S5DAYS", "S14DAYS", "S1MONTH", "S2MONTHS", "S3MONTHS", "S6MONTHS", "S1YEAR" ] }, "IdentityType": { "type": "string", "enum": [ "COMMON", "VOUCHER", "EXTERNAL" ] }, "IdentityInformationRequest": { "properties": { "clientIp": { "description": "Client IP address", "type": "string", "format": "ipv4", "example": "192.0.2.1", "nullable": true }, "clientMac": { "description": "Client MAC address", "type": "string", "example": "00:11:22:33:44:55", "nullable": true }, "clientOs": { "description": "Client operating system", "type": "string", "example": "Windows 10", "nullable": true }, "clientLocale": { "description": "Client locale", "type": "string", "example": "en_US", "nullable": true }, "clientpId": { "description": "Portal parameter pId", "type": "string", "example": "12345", "nullable": true }, "clientnId": { "description": "Portal parameter nId", "type": "string", "example": "10.0.0.1", "nullable": true }, "clientSsid": { "description": "Portal SSID", "type": "string", "example": "Guest_WiFi", "nullable": true }, "clientSite": { "description": "Client Site", "type": "string", "nullable": true } }, "type": "object" }, "ViewWindowsRegistryResponse": { "required": [ "id", "key", "value", "type" ], "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "ReauthParameter": { "type": "string", "enum": [ "ANTIVIRUS", "NO_ANTIVIRUS", "FIREWALL", "NO_FIREWALL", "UP2DATE", "ENCRYPTED", "IS_DOMAIN", "IS_DHCP", "PROCESS", "REGISTRY", "DIR", "APPLICATION", "SERVICE", "LINK_SHARING" ] }, "RepairProgram": { "type": "string", "enum": [ "SERVICE", "UP2DATE" ] }, "MiniListObjectGroupConfigResponse": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "StatusRefreshInterval": { "type": "string", "enum": [ "PT5M", "PT10M", "PT30M", "PT1H", "PT2H" ] }, "ConfigRefreshInterval": { "type": "string", "enum": [ "PT1H", "PT2H", "PT4H", "PT8H" ] }, "DataValidateInterval": { "type": "string", "enum": [ "PT1H", "PT2H", "PT6H", "PT12H", "P1D", "P2D", "P3D", "P5D", "P7D" ] }, "WindowsRegistryRequest": { "required": [ "key", "value", "type" ], "properties": { "key": { "type": "string", "maxLength": 255 }, "value": { "type": "string", "maxLength": 255 }, "type": { "$ref": "#/components/schemas/WindowsRegistryType" } }, "type": "object" }, "NetworkDeviceType": { "type": "string", "enum": [ "NETWORK_DEVICE", "WIFI_CONTROLER", "WIFI_AP", "NETWORK_PROXY" ] }, "DownloadInterval": { "type": "string", "enum": [ "P1D", "P7D", "P1M" ] }, "Firmware": { "type": "string", "enum": [ "arista_eos", "aruba_wlc", "cisco_ios_xe", "cisco_ios_xr", "cisco_nx_os", "cisco_dcn", "cumulus_linux_nvidia", "cumulus_linux_edgecore", "cumulus_linux_dell", "cumulus_linux_hpe", "cumulus_linux_lenovo", "cumulus_linux_delta", "cumulus_linux_accton", "cumulus_linux_fs", "nvidia_cumulus_linux_cli", "hp_comware_hpe", "hp_comware_h3c", "huawei_vrp", "juniper_junos", "nokia_sr_linux", "nokia_sr_os", "nokia_sr_os_classic", "paloalto_pan_os", "ruijie_argos", "vyatta_vyos", "vyos_supermicro", "vyos_advantech", "ipinfusion_ocnos", "ocnos_edgecore", "ocnos_ufispace", "ocnos_celestica", "ocnos_dell", "ocnos_delta", "ocnos_fs" ] }, "NetworkDeviceStatus": { "required": [ "statusType" ], "properties": { "statusType": { "$ref": "#/components/schemas/NetworkDeviceService" }, "status": { "$ref": "#/components/schemas/NetworkDeviceStatusEnum" }, "error": { "type": "string", "default": "" } }, "type": "object" }, "NetworkDeviceMonitoring": { "properties": { "lastAccessAt": { "type": "string", "format": "date-time", "nullable": true }, "isOnline": { "type": "integer", "nullable": true } }, "type": "object" }, "ProfilingRuleStrategyType": { "type": "string", "enum": [ "AND", "OR" ] }, "ViewProfilingDefinitionRuleResponse": { "required": [ "value", "type" ], "properties": { "value": { "type": "string" }, "hostname": { "type": "string", "nullable": true }, "vendor": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ProfilingRuleType" } }, "type": "object" }, "ProfilingDefinitionRuleRequest": { "required": [ "value", "hostname", "vendor", "type" ], "properties": { "value": { "type": "string", "maxLength": 255, "minLength": 1 }, "hostname": { "type": "string", "maxLength": 255, "minLength": 1 }, "vendor": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": { "$ref": "#/components/schemas/ProfilingRuleType" } }, "type": "object" }, "ConnectionType": { "type": "string", "enum": [ "COA", "SNMP", "TELNET" ] }, "MacType": { "type": "string", "enum": [ "MM:MM:MM:SS:SS:SS", "MM.MM.MM.SS.SS.SS", "MMM.MMM.SSS.SSS", "MM-MM-MM-SS-SS-SS", "MMMMMMSSSSSS" ] }, "CoaFormat": { "type": "string", "enum": [ "Generic", "Juniper EX series", "Brocade ICX", "Huawei", "UniFI", "Ruckus", "HP2500", "Cisco IOS series", "Cisco WLC", "Cisco WLC CoA", "FortiGate Firewall", "FortiGate", "Alcatel", "AeroHive", "Aruba", "Aruba CX", "Dell", "Enterasys", "Meraki", "Mikrotik", "Cisco IOS XE CoA", "Huawei CoA", "UniFi CaptivePortal API", "Cisco EWC CoA", "HPE CoA", "Ruckus CaptivePortal API", "Cisco C1300 CoA", "UniFi Machine CaptivePortal API" ] }, "ReauthCoaType": { "type": "string", "enum": [ "DISCONNECT", "COA", "DISCONNECT_COA" ] }, "IdentityMetadata": { "properties": { "clientIp": { "type": "string", "default": null, "nullable": true }, "clientMac": { "type": "string", "default": null, "nullable": true }, "clientOs": { "type": "string", "default": null, "nullable": true }, "clientLocale": { "type": "string", "default": null, "nullable": true }, "clientpId": { "type": "string", "default": null, "nullable": true }, "clientnId": { "type": "string", "default": null, "nullable": true }, "clientSsid": { "type": "string", "default": null, "nullable": true } }, "type": "object" }, "SnmpAuthLevel": { "type": "string", "enum": [ "noAuthNoPriv", "authNoPriv", "authPriv" ] }, "SnmpVersion": { "type": "string", "enum": [ "v1", "v2c", "v3" ] }, "SnmpCryptoalgo": { "type": "string", "enum": [ "DES", "AES", "AES-192", "AES-192-C", "AES-256", "AES-256-C" ] }, "SnmpAuthAlgo": { "type": "string", "enum": [ "MD5", "SHA", "SHA-224", "SHA-256", "SHA-384", "SHA-512" ] }, "StatusType": { "type": "string", "enum": [ "ping", "snmp", "dns", "ok" ] }, "MonitoringPortsResponse": { "required": [ "ifconnectorpresent", "isDisabled", "deviceId", "encrypted", "isDeleted" ], "properties": { "ifdescr": { "type": "string", "nullable": true }, "portLabel": { "type": "string", "nullable": true }, "portLabelShort": { "type": "string", "nullable": true }, "ifindex": { "type": "string", "nullable": true }, "portLabelBase": { "type": "string", "nullable": true }, "portLabelNum": { "type": "string", "nullable": true }, "ifname": { "type": "string", "nullable": true }, "iftype": { "type": "string", "nullable": true }, "ifconnectorpresent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "deviceId": { "type": "integer" }, "encrypted": { "type": "boolean" }, "isDeleted": { "type": "boolean" } }, "type": "object" }, "SmtpConnectionProtocolType": { "type": "string", "enum": [ "smtp", "sendmail" ] }, "SmtpAuthType": { "type": "string", "enum": [ "login", "plain" ] }, "SmtpEncryptionType": { "type": "string", "enum": [ "SSL", "TLS", "NONE" ] }, "NotificationType": { "type": "string", "enum": [ "SMS", "EMAIL", "SYSLOG", "WEBHOOK" ] }, "NotifyTime": { "type": "string", "enum": [ "P1D", "P7D", "P1M" ] }, "NotificationModule": { "type": "string", "enum": [ "PKI", "CERTIFICATE", "DISK", "LICENSE", "SERVICE", "AUTHORIZATION", "LDAP", "SMTP", "SMS", "REBUILD_CONFIG", "CP_RESET_TOKEN" ] }, "NotificationTemplatePurposeTypeEnum": { "type": "string", "enum": [ "header", "body", "sms" ] }, "NotificationTemplateTypeEnum": { "type": "string", "enum": [ "reset_password", "identity_reset_password", "identity_reset_password_sms", "inactive_account", "vpn_client_configuration", "wifi_password_access", "certificate_pki_client", "cp_account_activation", "account_activated", "account_activated_sms", "token_mfa_sms", "token_mfa_email", "custom_email", "core_template" ] }, "SmsServiceTypeEnum": { "type": "string", "enum": [ "SMS_API", "GSM_SERVICE", "SERWER_SMS", "AFILNET", "CLICKATELL", "ASP_SMS", "HOSTED_SMS", "INTELLI_SMS", "VONAGE", "SMS_EAGLE", "NOW_SMS", "SWISSCOM", "OVH_SMS" ] }, "NotificationMessageType": { "type": "string", "enum": [ "upgrade_slave_system_node", "upgrade_master_system_node", "identity_multi_creator", "sync_authorization_server", "matrix_policy_action", "send_email_on_user_request", "notification_channel_status", "creator_smtp", "creator_sms", "send_email", "send_mfa_email", "send_user_reset_password_email", "send_identity_reset_password_email", "verify_user_reset_password_token", "verify_identity_reset_password_token", "send_sms", "send_mfa_sms", "verify_mfa_token", "send_reset_password_sms", "starting_archive_migration", "execute_network_device_commands", "network_device_reauth", "network_device_download_configuration", "queue_rebuild_configuration", "queue_refresh_dns", "refresh_object_certificate", "refresh_system_node_configuration", "create_object_certificate", "sent_backup_to_remote_server", "event_pattern", "replication_db", "skip_if_value_already_persisted", "check_network_device_status", "create_import" ] }, "TriggeredByCategory": { "type": "string", "enum": [ "export-import", "creator", "notification-channel" ] }, "NotificationStatus": { "type": "string", "enum": [ "INIT", "IN-PROGRESS", "WARNING", "ERROR", "DONE", "INFO", "VIOLATION" ] }, "ViewNotificationMessageResponse": { "required": [ "id", "type", "createdAt", "name" ], "properties": { "id": { "type": "integer" }, "type": { "$ref": "#/components/schemas/NotificationStatus" }, "createdAt": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "info": { "type": "string", "nullable": true } }, "type": "object" }, "DeviceCredentialsTypeEnum": { "type": "string", "enum": [ "SNMPv1", "SNMPv2c", "SNMPv3", "Telnet", "SSH", "API" ] }, "DeviceCredentialsAuthLevelEnum": { "type": "string", "enum": [ "no_auth_no_priv", "auth_no_priv", "auth_priv" ] }, "DeviceCredentialsAuthAlgorithmEnum": { "type": "string", "enum": [ "MD5", "SHA", "SHA-224", "SHA-256", "SHA-384", "SHA-512" ] }, "DeviceCredentialsAuthConnectionEnum": { "type": "string", "enum": [ "AES", "DES", "AES-192", "AES-192-C", "AES-256", "AES-256-C" ] }, "EventSource": { "type": "string", "enum": [ "SYSLOG", "SNMP" ] }, "TemplateType": { "type": "string", "enum": [ "PALO_ALTO_SNMP", "PALO_ALTO_SYSLOG", "FORTIGATE_SYSLOG" ] }, "ActionType3": { "type": "string", "enum": [ "EMAIL", "SMS", "BLOCK", "WEBHOOK", "SYSLOG", "SCRIPT" ] }, "TimeUnit": { "type": "string", "enum": [ "PT5M", "PT10M", "PT30M", "PT1H", "PT2H", "PT4H", "PT8H", "PT12H", "PT24H" ] }, "ActionHttpRequestType": { "type": "string", "enum": [ "GET", "POST" ] }, "QueueRebuildConfigurator": { "type": "string", "enum": [ "PKI", "TacacsServer", "LdapService", "SMTP", "SNMP", "Syslog", "Eduroam", "DisasterRecovery", "CaptivePortal", "SystemNodeFirewall", "SystemNodeInterface" ] }, "IntervalJobsEnum": { "type": "string", "enum": [ "P1D", "P1M", "P3M", "P7D", "PT15M", "PT1H", "PT30M", "PT3H", "PT5M" ] }, "CategoryEnum": { "type": "string", "enum": [ "msevents", "accounting", "eventlog", "snmptrap", "otp", "authorize", "dhcp", "tacacs", "syslog", "system", "dhcputilization" ] }, "LogRotationInterval": { "type": "string", "enum": [ "P3M", "P6M", "P1Y", "P2Y", "P3Y", "P4Y", "P5Y", "P10Y" ] }, "AuthEventsCategoryAggregationItem": { "required": [ "count" ], "properties": { "id": { "type": "integer", "nullable": true }, "count": { "type": "integer" } }, "type": "object" }, "IndexesStateEnum": { "type": "string", "enum": [ "green", "yellow", "red" ] }, "BackupProtocol": { "type": "string", "enum": [ "FTP", "SFTP", "SCP", "SMB", "NAS" ] }, "SmbProtocolVersion": { "type": "string", "enum": [ "3.0", "2.1", "2.0", "1.0" ] }, "BackupInterval": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH" ] }, "DisasterRecoveryInterval": { "type": "string", "enum": [ "HOUR", "DAY", "WEEK", "MONTH" ] }, "SystemLicenseType": { "type": "string", "enum": [ "NFR", "NORMAL", "ANNUAL", "DEMO" ] }, "SystemNodeStatus": { "type": "string", "enum": [ "NEW", "CONFIRMED" ] }, "SystemNodeType": { "type": "string", "enum": [ "WORKER", "MASTER", "ARCHIVE" ] }, "FirewallType": { "type": "string", "enum": [ "TCP", "UDP" ] }, "SystemNodeService": { "type": "string", "enum": [ "SSH", "PING", "WWW", "DHCP", "TACACS", "RADIUS", "OTP", "NTP", "SNMP", "SYSLOG", "CP", "SCEP", "OCSP", "ZABBIX" ] }, "SystemNodeStatusDetails": { "required": [ "id", "name", "status", "updatedAt", "hash" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/SystemStatus" }, "updatedAt": { "type": "string" }, "hash": { "type": "string" }, "authorizationServerStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorizationServerStatus" } ] }, "certificateStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CertificateStatus" } ] }, "pkiStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PkiStatus" } ] }, "ldapStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LdapStatus" } ] }, "serviceStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ServiceStatus" } ] }, "smtpStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmtpStatus" } ] }, "smsStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmsStatus" } ] }, "systemLicenseStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SystemLicenseStatus" } ] }, "diskStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DiskStatus" } ] }, "rebuildConfigRequiredStatus": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RebuildConfigRequiredStatus" } ] }, "version": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VersionStatus" } ] } }, "type": "object" }, "ResourceRouteEnum": { "type": "string", "enum": [ "vlan", "wifi-network", "subnetwork", "dhcp-option", "endpoint-device", "endpoint-device-parameter", "event-definition", "indexes", "matrix-policy", "matrix-policy-category", "matrix-policy-option", "matrix-policy-profile-action", "matrix-policy-time", "nacview-assistant", "nacview-scout", "system-license", "dhcp-whitelist", "ip-address", "pki", "user", "authorization-server", "integration-server", "ldap-service", "ldap-service-system-node-parameter", "tacacs-server", "printable-template", "notification-template", "object-group", "mac-address", "identity-voucher", "identity-common", "identity-external", "identity", "color-identifier", "organization-unit", "device-credential", "object-certificate", "access-group", "notification-channel", "captive-portal", "captive-portal-sponsor", "captive-portal-registration-form", "captive-portal-object-group-config", "system-node", "system-node-firewall", "network-device", "vrrp-system-node", "reauth-device-credential", "sector", "profiling-definition", "port", "archive", "notification", "events-dhcp", "events-accounting", "events-tacacs", "events-otp", "events-snmptrap", "events-msevents", "events-syslog", "events-authorize", "system-node-routing" ] }, "RepeatedField": { "required": [ "iterator" ], "properties": { "iterator": { "$ref": "#/components/schemas/Traversable" } }, "type": "object" }, "WindowsRegistryType": { "type": "string", "enum": [ "REG_MULTI_SZ", "REG_SZ", "REG_DWORD", "REG_QWORD", "REG_EXPAND_SZ" ] }, "NetworkDeviceService": { "type": "string", "enum": [ "CLI", "SNMP", "SYSLOG", "PING", "RADIUS" ] }, "NetworkDeviceStatusEnum": { "type": "string", "enum": [ "OK", "WARNING", "ERROR" ] }, "ProfilingRuleType": { "type": "string", "enum": [ "DHCP", "TCP_UDP", "SNMP", "RADIUS" ] }, "SystemStatus": { "type": "string", "enum": [ "ERROR", "WARNING", "OK" ] }, "AuthorizationServerStatus": { "properties": { "AUTHORIZATION": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "nullable": true } }, "type": "object" }, "CertificateStatus": { "properties": { "CERTIFICATE": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "default": null, "nullable": true } }, "type": "object" }, "PkiStatus": { "properties": { "PKI": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "default": null, "nullable": true } }, "type": "object" }, "LdapStatus": { "properties": { "LDAP": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "default": null, "nullable": true } }, "type": "object" }, "ServiceStatus": { "properties": { "SERVICE": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "default": null, "nullable": true } }, "type": "object" }, "SmtpStatus": { "properties": { "SMTP": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "nullable": true } }, "type": "object" }, "SmsStatus": { "properties": { "SMS": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "nullable": true } }, "type": "object" }, "SystemLicenseStatus": { "properties": { "LICENSE": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "default": null, "nullable": true } }, "type": "object" }, "DiskStatus": { "properties": { "DISK": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "default": null, "nullable": true } }, "type": "object" }, "RebuildConfigRequiredStatus": { "properties": { "REBUILD_CONFIG": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "nullable": true } }, "type": "object" }, "VersionStatus": { "properties": { "VERSION": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultResultConnection" }, "default": null, "nullable": true } }, "type": "object" }, "Traversable": { "type": "object" }, "DefaultResultConnection": { "required": [ "name", "status", "messages" ], "properties": { "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/SystemStatus" }, "messages": { "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "securitySchemes": { "Bearer": { "type": "http", "bearerFormat": "JWT", "scheme": "bearer" } } }, "security": [ { "Bearer": [ "message" ] } ], "tags": [ { "name": "Action Groups" }, { "name": "Archive" }, { "name": "System Configuration" }, { "name": "State Manager" }, { "name": "Exception Message Codes" }, { "name": "Nacview Assistant" }, { "name": "User" }, { "name": "Access Group" }, { "name": "Reset password" }, { "name": "Login" }, { "name": "User Access" }, { "name": "Matrix Policy" }, { "name": "Matrix Policy Category" }, { "name": "Matrix Policy Option" }, { "name": "Matrix Policy Option Item" }, { "name": "Matrix Policy Profile Action" }, { "name": "Matrix Policy Rule" }, { "name": "Matrix Policy Time" }, { "name": "Access Group External Identifier" }, { "name": "Authorization Server" }, { "name": "Integration Server" }, { "name": "LDAP Service" }, { "name": "Ldap Service Referral" }, { "name": "LDAP Service System Node Parameter" }, { "name": "Object Group External Identifier" }, { "name": "TACACS Server" }, { "name": "TACACS Server Custom Parameter" }, { "name": "TACACS Server Settings" }, { "name": "Object Certificate" }, { "name": "PKI" }, { "name": "Import/Export" }, { "name": "Monitoring" }, { "name": "Color Identifier" }, { "name": "Dhcp Option" }, { "name": "Dhcp Option Item" }, { "name": "DHCP Whitelist" }, { "name": "Ip Address" }, { "name": "Object Group" }, { "name": "Port" }, { "name": "Printable Template" }, { "name": "Sector" }, { "name": "Subnetwork" }, { "name": "VLAN" }, { "name": "Wifi Network" }, { "name": "Captive Portal Sponsor" }, { "name": "Captive Portal" }, { "name": "Captive Portal Object Group Config" }, { "name": "Captive Portal Registration Form" }, { "name": "Endpoint Device" }, { "name": "Identity" }, { "name": "Identity Authentication" }, { "name": "Mac Address" }, { "name": "Nacview Scout" }, { "name": "Nacview Scout Object Group Config" }, { "name": "Network Device" }, { "name": "Profiling Definition" }, { "name": "Reauth Device Credential" }, { "name": "Endpoint Device Parameter" }, { "name": "Mac Address Vendor" }, { "name": "CUSTOM NOTIFICATION" }, { "name": "Notification Channel" }, { "name": "Notification Template" }, { "name": "Notification" }, { "name": "Device Credential" }, { "name": "Organization Unit" }, { "name": "Event Definition" }, { "name": "Queue" }, { "name": "Events" }, { "name": "Indexes" }, { "name": "System License" }, { "name": "System Node" }, { "name": "System Node Firewall" }, { "name": "System Node Interface" }, { "name": "System Node Routing" }, { "name": "System Node Status" }, { "name": "Vrrp System Node" }, { "name": "TFTP" } ] }