Рабочие столы. Обзор

Основные характеристики

Характеристика	Значение
Наименование	dashboards
Компоненты	Cruddy
Появился в версии	3.7.1
Доступен в версиях	3.7.1 и выше
Авторизация по токену	Security scheme type: http Bearer format: JWT
Авторизация по APIkey	Security scheme type: apiKey Header parameter name: PgrApiKey
Параметры заголовка	Pgr-User-ID: ID пользователя (uuid)
Версия API	v2

Описание: Ресурс dashboards отвечает за управление рабочими столами, которые доступны в разделе Администрирование → Рабочие столы.

Рабочие столы - это интерактивные информационные панели, которые отображают данные о состоянии информационной безопасности.

Список методов для работы с ресурсом

Тип	Метод	Описание
POST	/dashboards/create	Создание рабочего стола
PUT	/dashboards/update	Обновление информации о рабочем столе
POST	/dashboards/search	Поиск рабочих столов
GET	/dashboards/{id}	Получение рабочего стола по ID
DELETE	/dashboards/{id}	Удаление рабочего стола
POST	/dashboards/group	Группировка рабочих столов
POST	/dashboards/{id}/copy	Копирование рабочего стола
POST	dashboards/{id}/allow_access_for_groups	Предоставление доступа к рабочему столу группе пользователей
POST	dashboards/{id}/allow_access_for_users	Предоставление доступа к рабочему столу отдельным пользователям
POST	dashboards/{id}/restrict_access_for_groups	Ограничение доступа к рабочему столу группе пользователей
POST	dashboards/{id}/restrict_access_for_users	Ограничение доступа к рабочему столу отдельным пользователям

Ответы методов

Статус код	Описание
200	Успех
201	Успешное создание объекта
204	Успешный ответ. Пустое тело ответа
400	Неверный тип параметра запроса, либо отсутствует обязательный параметр
403	Пользователь с ID = “Pgr-User-ID” не является владельцем рабочего стола, либо администратором
404	Ресурс не найден
409	Попытка создать объект с существующим уникальным атрибутом
422	Внутренние ошибки удаления
500	Ошибка сервера

Модели объектов

Название	Описание
Dashboard	Модель данных ресурса dashboards