{ "swagger": "2.0", "info": { "title": "Континент 4.0", "description": "API Сервера конфигурирования Континент 4", "version": "1.0.0" }, "schemes": [ "http" ], "tags": [ { "name": "administration" }, { "name": "config" }, { "name": "consumer" }, { "name": "param" }, { "name": "rule" }, { "name": "firewall" }, { "name": "structure" } ], "basePath": "/api-v1-objects", "produces": [ "application/json" ], "paths": { "/config/{config_id}/additionaladdresses": { "get": { "summary": "Возвращает список сущностей типа additionaladdresses", "tags": [ "structure" ], "description": "\n Важный класс для взаимодействия узлов\n\n В этой табличке хранятся все адреса интерфейсов и адреса прокси серверов по котором нижележащие узлы\n должны подсоединяться к вышестоящим\n\n При изменении или привязке новых адресов к Узлу, происходит синхронизация адресов в этой табличке с\n адресами в интерфейсах\n \n\n", "x-view-description": "", "responses": { "200": { "description": "Сериализованный список сущностей типа {}", "schema": { "type": "array", "items": { "$ref": "additionaladdresses" } } } }, "parameters": [ { "in": "path", "name": "config_id", "default": "active", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "q", "description": "Запрос выбора объекта", "required": false, "type": "string" }, { "name": "view", "in": "query", "description": "Режим представления объекта", "required": false, "type": "string", "enum": [ "short", "full" ] } ] }, "post": { "summary": "Создает новую сущность типа additionaladdresses", "tags": [ "structure" ], "description": "\n Важный класс для взаимодействия узлов\n\n В этой табличке хранятся все адреса интерфейсов и адреса прокси серверов по котором нижележащие узлы\n должны подсоединяться к вышестоящим\n\n При изменении или привязке новых адресов к Узлу, происходит синхронизация адресов в этой табличке с\n адресами в интерфейсах\n \n\n", "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "additionaladdresses_edit" } }, { "in": "path", "name": "config_id", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "UUID нового объекта", "schema": { "$ref": "response_uuid" } } } } }, "/config/{config_id}/additionaladdresses/{object_id}": { "get": { "summary": "Возвращает список сущностей типа additionaladdresses", "tags": [ "structure" ], "description": "\n Важный класс для взаимодействия узлов\n\n В этой табличке хранятся все адреса интерфейсов и адреса прокси серверов по котором нижележащие узлы\n должны подсоединяться к вышестоящим\n\n При изменении или привязке новых адресов к Узлу, происходит синхронизация адресов в этой табличке с\n адресами в интерфейсах\n \n\n", "x-view-description": "", "responses": { "200": { "description": "Сериализованный список сущностей типа {}", "schema": { "type": "array", "items": { "$ref": "additionaladdresses" } } } }, "parameters": [ { "in": "path", "name": "config_id", "default": "active", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "q", "description": "Запрос выбора объекта", "required": false, "type": "string" }, { "in": "path", "name": "object_id", "description": "Идентификатор объекта", "required": true, "type": "string", "format": "uuid" }, { "name": "view", "in": "query", "description": "Режим представления объекта", "required": false, "type": "string", "enum": [ "short", "full" ] } ] }, "put": { "summary": "Вносит изменения в сущность типа additionaladdresses", "tags": [ "structure" ], "description": "\n Важный класс для взаимодействия узлов\n\n В этой табличке хранятся все адреса интерфейсов и адреса прокси серверов по котором нижележащие узлы\n должны подсоединяться к вышестоящим\n\n При изменении или привязке новых адресов к Узлу, происходит синхронизация адресов в этой табличке с\n адресами в интерфейсах\n \n\n", "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "additionaladdresses_edit" } }, { "in": "path", "name": "config_id", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "object_id", "description": "Идентификатор объекта", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "UUID нового объекта", "schema": { "$ref": "response_uuid" } } } }, "delete": { "summary": "Удаляет сущность типа additionaladdresses", "tags": [ "structure" ], "description": "\n Важный класс для взаимодействия узлов\n\n В этой табличке хранятся все адреса интерфейсов и адреса прокси серверов по котором нижележащие узлы\n должны подсоединяться к вышестоящим\n\n При изменении или привязке новых адресов к Узлу, происходит синхронизация адресов в этой табличке с\n адресами в интерфейсах\n \n\n", "parameters": [ { "in": "path", "name": "config_id", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "object_id", "description": "Идентификатор объекта", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "UUID нового объекта", "schema": { "$ref": "response_uuid" } } } } }, "/config/{config_id}/admin": { "get": { "summary": "Возвращает список сущностей типа admin", "tags": [ "administration" ], "description": "\n Администратор (пользователь ПУ ЦУС)\n \n\n", "x-view-description": "", "responses": { "200": { "description": "Сериализованный список сущностей типа {}", "schema": { "type": "array", "items": { "$ref": "admin" } } } }, "parameters": [ { "in": "path", "name": "config_id", "default": "active", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "q", "description": "Запрос выбора объекта", "required": false, "type": "string" }, { "name": "view", "in": "query", "description": "Режим представления объекта", "required": false, "type": "string", "enum": [ "short", "full" ] } ] }, "post": { "summary": "Создает новую сущность типа admin", "tags": [ "administration" ], "description": "\n Администратор (пользователь ПУ ЦУС)\n \n\n", "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "admin_edit" } }, { "in": "path", "name": "config_id", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "UUID нового объекта", "schema": { "$ref": "response_uuid" } } } } }, "/config/{config_id}/admin/{object_id}": { "get": { "summary": "Возвращает список сущностей типа admin", "tags": [ "administration" ], "description": "\n Администратор (пользователь ПУ ЦУС)\n \n\n", "x-view-description": "", "responses": { "200": { "description": "Сериализованный список сущностей типа {}", "schema": { "type": "array", "items": { "$ref": "admin" } } } }, "parameters": [ { "in": "path", "name": "config_id", "default": "active", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "q", "description": "Запрос выбора объекта", "required": false, "type": "string" }, { "in": "path", "name": "object_id", "description": "Идентификатор объекта", "required": true, "type": "string", "format": "uuid" }, { "name": "view", "in": "query", "description": "Режим представления объекта", "required": false, "type": "string", "enum": [ "short", "full" ] } ] }, "put": { "summary": "Вносит изменения в сущность типа admin", "tags": [ "administration" ], "description": "\n Администратор (пользователь ПУ ЦУС)\n \n\n", "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "admin_edit" } }, { "in": "path", "name": "config_id", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "object_id", "description": "Идентификатор объекта", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "UUID нового объекта", "schema": { "$ref": "response_uuid" } } } }, "delete": { "summary": "Удаляет сущность типа admin", "tags": [ "administration" ], "description": "\n Администратор (пользователь ПУ ЦУС)\n \n\n", "parameters": [ { "in": "path", "name": "config_id", "description": "Идентификатор конфигурации", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "object_id", "description": "Идентификатор объекта", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "UUID нового объекта", "schema": { "$ref": "response_uuid" } } } } }, "/config/{config_id}/adminrole": { "get": { "summary": "Возвращает список сущностей типа adminrole", "tags": [ "administration" ], "description": "\n Роль администратора, которая определяет какими привилегиями владеет администратор\n Вычисление возможности выполнения операции производится в VCore\n \n\n#### Предопределенные элементы\n\n```json\n\n[\n {\n \"is_autocreated\": true,\n \"is_deleted\": false,\n \"name\": \"\\u0413\\u043b\\u0430\\u0432\\u043d\\u044b\\u0439 \\u0430\\u0434\\u043c\\u0438\\u043d\\u0438\\u0441\\u0442\\u0440\\u0430\\u0442\\u043e\\u0440\",\n \"privileges\": [\n \"STRUCTURE_ACCESS\",\n \"MANAGE_ADMIN\",\n \"PRIMARY_ADMIN\",\n \"VIEW_ADMIN\",\n \"DATA_ALARM_IDS\",\n \"DATA_AUDIT\",\n \"VIEW_BACKUP\",\n \"MANAGE_CERT\",\n \"VIEW_CERT\",\n \"DIAGNOSTIC_CGW\",\n \"MANAGE_CGW\",\n \"REGISTER_CGW\",\n \"VIEW_CGW\",\n \"DATA_COUNT_ATTACK\",\n \"BACKUP_CREATE\",\n \"MANAGE_EXTENDED_RNCC_SYNC\",\n \"MANAGE_FIREWALL\",\n \"VIEW_FIREWALL\",\n \"MANAGE_GROUP\",\n \"VIEW_GROUP\",\n \"GROUPS\",\n \"DATA_IDS\",\n \"INCIDENT_IDS\",\n \"MANAGE_IDS\",\n \"VIEW_IDS\",\n \"MANAGE_LICENSE\",\n \"VIEW_LICENSE\",\n \"FORCE_LOCK\",\n \"AUDIT_LOG\",\n \"MANAGE_LOG\",\n \"MANAGEMENT_LOG\",\n \"VIEW_LOG\",\n \"DATA_MANAGEMENT\",\n \"EMERGENCY_MENU\",\n \"DATA_MONITORING\",\n \"PANEL_MONITORING\",\n \"MANAGE_NCC\",\n \"VIEW_NCC\",\n \"MANAGE_NETOBJECT_AND_SERVICE\",\n \"VIEW_NETOBJECT_AND_SERVICE\",\n \"DATA_NETWORK\",\n \"MANAGE_NETWORK_FACILITIES\",\n \"VIEW_NETWORK_FACILITIES\",\n \"MANAGE_NETWORK_INTERFACES\",\n \"CHANGE_PASSWORD\",\n \"MANAGE_PASSWORD\",\n \"VIEW_PASSWORD\",\n \"INSTALL_POLICY\",\n \"LOCAL_POLICY\",\n \"REINIT\",\n \"MANAGE_REPLICATION\",\n \"VIEW_REPLICATION\",\n \"NODE_SHUTDOWN_RESTART\",\n \"UPDATE_SOFTWARE\",\n \"VIEW_SOFTWARE_UPDATES\",\n \"ACCESS_SSH\",\n \"MANAGE_SSH\",\n \"STATISTICS\",\n \"STRUCTURE\",\n \"DATA_TOP_FAILED_NODES\",\n \"DATA_TOP_SIGNATURE\",\n \"DATA_TOP_SOURCE_ATTACK\",\n \"DATA_TOP_VICTIM_ATTACK\",\n \"MANAGE_USER_SESSIONS\",\n \"VIEW_USER_SESSIONS\"\n ],\n \"revision\": \"754e6b23-d017-4bf6-ad00-2a91df46292d\",\n \"type\": \"adminrole\",\n \"uuid\": \"0af6a848-ed03-11e4-8958-000c29e649e1\"\n },\n {\n \"is_autocreated\": true,\n \"is_deleted\": false,\n \"name\": \"\\u0410\\u0434\\u043c\\u0438\\u043d\\u0438\\u0441\\u0442\\u0440\\u0430\\u0442\\u043e\\u0440 \\u0441\\u0435\\u0442\\u0438\",\n \"privileges\": [\n \"VIEW_ADMIN\",\n \"DATA_AUDIT\",\n \"VIEW_BACKUP\",\n \"VIEW_CERT\",\n \"DIAGNOSTIC_CGW\",\n \"REGISTER_CGW\",\n \"VIEW_CGW\",\n \"BACKUP_CREATE\",\n \"MANAGE_FIREWALL\",\n \"VIEW_FIREWALL\",\n \"MANAGE_GROUP\",\n \"VIEW_GROUP\",\n \"VIEW_IDS\",\n \"VIEW_LICENSE\",\n \"AUDIT_LOG\",\n \"MANAGEMENT_LOG\",\n \"VIEW_LOG\",\n \"DATA_MANAGEMENT\",\n \"DATA_MONITORING\",\n \"PANEL_MONITORING\",\n \"MANAGE_NETOBJECT_AND_SERVICE\",\n \"DATA_NETWORK\",\n \"MANAGE_NETWORK_FACILITIES\",\n \"VIEW_NETWORK_FACILITIES\",\n \"MANAGE_NETWORK_INTERFACES\",\n \"INSTALL_POLICY\",\n \"LOCAL_POLICY\",\n \"NODE_SHUTDOWN_RESTART\",\n \"UPDATE_SOFTWARE\",\n \"VIEW_SOFTWARE_UPDATES\",\n \"STATISTICS\",\n \"STRUCTURE\",\n \"DATA_TOP_FAILED_NODES\"\n ],\n \"revision\": \"754e6b23-d017-4bf6-ad00-2a91df46292d\",\n \"type\": \"adminrole\",\n \"uuid\": \"0d7f30e4-ed03-11e4-92c5-000c29e649e1\"\n },\n {\n \"is_autocreated\": true,\n \"is_deleted\": false,\n \"name\": \"\\u0410\\u0434\\u043c\\u0438\\u043d\\u0438\\u0441\\u0442\\u0440\\u0430\\u0442\\u043e\\u0440 \\u0431\\u0435\\u0437\\u043e\\u043f\\u0430\\u0441\\u043d\\u043e\\u0441\\u0442\\u0438\",\n \"privileges\": [\n \"STRUCTURE_ACCESS\",\n \"VIEW_ADMIN\",\n \"DATA_ALARM_IDS\",\n \"DATA_AUDIT\",\n \"VIEW_BACKUP\",\n \"MANAGE_CERT\",\n \"DIAGNOSTIC_CGW\",\n \"MANAGE_CGW\",\n \"DATA_COUNT_ATTACK\",\n \"BACKUP_CREATE\",\n \"MANAGE_FIREWALL\",\n \"MANAGE_GROUP\",\n \"VIEW_GROUP\",\n \"GROUPS\",\n \"DATA_IDS\",\n \"INCIDENT_IDS\",\n \"MANAGE_IDS\",\n \"VIEW_LICENSE\",\n \"AUDIT_LOG\",\n \"MANAGEMENT_LOG\",\n \"VIEW_LOG\",\n \"DATA_MANAGEMENT\",\n \"EMERGENCY_MENU\",\n \"DATA_MONITORING\",\n \"PANEL_MONITORING\",\n \"VIEW_NETOBJECT_AND_SERVICE\",\n \"MANAGE_NETWORK_FACILITIES\",\n \"VIEW_NETWORK_FACILITIES\",\n \"MANAGE_NETWORK_INTERFACES\",\n \"INSTALL_POLICY\",\n \"LOCAL_POLICY\",\n \"NODE_SHUTDOWN_RESTART\",\n \"VIEW_SOFTWARE_UPDATES\",\n \"MANAGE_SSH\",\n \"STATISTICS\",\n \"STRUCTURE\",\n \"DATA_TOP_FAILED_NODES\",\n \"DATA_TOP_SIGNATURE\",\n \"DATA_TOP_SOURCE_ATTACK\",\n \"DATA_TOP_VICTIM_ATTACK\",\n \"MANAGE_USER_SESSIONS\",\n \"VIEW_USER_SESSIONS\"\n ],\n \"revision\": \"754e6b23-d017-4bf6-ad00-2a91df46292d\",\n \"type\": \"adminrole\",\n \"uuid\": \"0fd29066-ed03-11e4-8db2-000c29e649e1\"\n },\n {\n \"is_autocreated\": true,\n \"is_deleted\": false,\n \"name\": \"\\u0410\\u0434\\u043c\\u0438\\u043d\\u0438\\u0441\\u0442\\u0440\\u0430\\u0442\\u043e\\u0440 \\u0430\\u0443\\u0434\\u0438\\u0442\\u0430\",\n \"privileges\": [\n \"VIEW_ADMIN\",\n \"DATA_AUDIT\",\n \"VIEW_BACKUP\",\n \"VIEW_CERT\",\n \"DIAGNOSTIC_CGW\",\n \"VIEW_CGW\",\n \"DATA_COUNT_ATTACK\",\n \"BACKUP_CREATE\",\n \"VIEW_FIREWALL\",\n \"INCIDENT_IDS\",\n \"VIEW_IDS\",\n \"VIEW_LICENSE\",\n \"AUDIT_LOG\",\n \"MANAGEMENT_LOG\",\n \"VIEW_LOG\",\n \"PANEL_MONITORING\",\n \"VIEW_NETOBJECT_AND_SERVICE\",\n \"VIEW_NETWORK_FACILITIES\",\n \"INSTALL_POLICY\",\n \"VIEW_SOFTWARE_UPDATES\",\n \"STATISTICS\",\n \"DATA_TOP_FAILED_NODES\",\n \"DATA_TOP_SIGNATURE\",\n \"DATA_TOP_SOURCE_ATTACK\",\n \"DATA_TOP_VICTIM_ATTACK\"\n ],\n \"revision\": \"754e6b23-d017-4bf6-ad00-2a91df46292d\",\n \"type\": \"adminrole\",\n \"uuid\": \"11b320bc-ed03-11e4-8539-000c29e649e1\"\n }\n]```\n\n
При модификации, в элементах массива можно указать код отдельной привилегии,\n модификатор \"~ALL\", модификатор \"@КОД_ГРУППЫ_ПРИВИЛЕГИЙ\"
\nПри модификации, в элементах массива можно указать код отдельной привилегии,\n модификатор \"~ALL\", модификатор \"@КОД_ГРУППЫ_ПРИВИЛЕГИЙ\"
\n