REST API. Начало работы с REST API компонента «Универсальный диспетчер» Termidesk

• выполнить запрос «https://disp.termidesk.local/api/auth/v5.1/authenticators»;
• запомнить значения параметров authUuid, authSmallName, auth;
• выполнить запрос «https://disp.termidesk.local/api/auth/v5.1/legacy/login» и заполнить экранные поля «Логин», «Пароль», «Название аутентификатора» (значение параметра auth из предыдущей команды), «UUID аутентификатора» (значение параметра authUuid из предыдущей команды), «Короткое название аутентификатора» (значение параметра authSmallName из предыдущей команды).

В приведенных командах disp.termidesk.local - сетевой адрес или полное доменное имя узла компонента «Универсальный диспетчер» Termidesk.

Для запросов проверки состояния сервера /api/health используется токен, определенный в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf в значении переменной HEALTH_CHECK_ACCESS_KEY.

Формат запроса к /api/health/check выглядит следующим образом:

curl -X 'GET' \
'https://disp.termidesk.local/api/health/check' \
-H 'accept: application/json' \
-H 'Authorization: Token 072bfec46ac7c42078bb41ff5f6d1ae201006f0824fb4b2bb8ab8befacb01058'

где:

Token 072... - токен, определенный в переменной HEALTH_CHECK_ACCESS_KEY файла /etc/opt/termidesk-vdi/termidesk.conf;

Для форматированного вывода рекомендуется установить пакет jq:

sudo apt install jq

и выполнить запрос, добавив в конец команды « | jq»:

curl -X 'GET' \
'https://disp.termidesk.local/api/health/check' \
-H 'accept: application/json' \
-H 'Authorization: Token 072bfec46ac7c42078bb41ff5f6d1ae201006f0824fb4b2bb8ab8befacb01058' | jq 

В случае, если запрос завершится ошибкой вида «curl: (60) SSL: no alternative certificate subject name matches target host name... curl failed to verify the legitimacy... », нужно дополнить запрос флагом --insecure, который отключит проверку валидности сертификатов:

Выполнение запроса без использования проверки SSL допустимо только на тестовых стендах. Для исправления ошибки в производственной среде необходимо установить валидные сертификаты на узел компонента «Универсальный диспетчер».

curl -X 'GET' \
'https://disp.termidesk.local/api/health/check' \
-H 'accept: application/json' \
-H 'Authorization: Token 072bfec46ac7c42078bb41ff5f6d1ae201006f0824fb4b2bb8ab8befacb01058' --insecure | jq

/api/<module>/<ver>/<name>/,

где:

<module> - наименование модуля, реализованного в REST API;

<ver> - версия;

<name> - наименование элемента. После наименования элемента также могут быть включены уникальные номера объектов и наименования других элементов.

Пример команды через curl:

curl -X 'GET' \
  'https://disp.termidesk.local/api/discover/' \
  -H 'accept: application/json' \
  -H 'X-Auth-Token: 7bjqtodywjd69dkpdta9ncqprifkr3pu'

• «discover» - используется для отображения списка модулей API, предоставляемого сервером (команда /api/discover/);
• «agent» - модуль взаимодействия с компонентом «Агент виртуального рабочего места»;
• «aggregator» - модуль взаимодействия с порталом «Агрегатор»;
• «ssa» - модуль взаимодействия с компонентом «Сессионный агент»;
• «auth» - модуль для аутентификации пользователей веб-интерфейса;
• «client» - модуль взаимодействия с компонентом «Клиент»;
• «health» - модуль проверок состояния Termidesk;
• «webui» -  модуль управления функциями, доступными через веб-интерфейс Termidesk;
• «wsproxy» - модуль взаимодействия с компонентом «Шлюз».

При этом список отображаемых модулей зависит от типа портала, который был выбран при установке «Универсального диспетчера»:

• «Портал администратора»: доступны «agent», «aggregator», «ssa», «auth», «discover», «health», «webui»;
• «Портал пользователя»: доступны «agent», «aggregator», «ssa», «auth», «discover», «health», «client», «wsproxy»;
• «Портал администратора» и «Портал пользователя»: доступны все модули.

Доступ предоставляется после авторизации в Termidesk.

По нажатию экранной кнопки [Try it out] в пространстве команд какого-либо модуля можно составить запрос и отправить его на выполнение экранной кнопкой [Execute]. После нажатия будет отображена также команда для запроса через curl.

Для ввода токена доступа к определенным командам нужно нажать экранную кнопку [Authorize] и ввести необходимые ключи:

• «legacyTokenAuth» - альтернативный способ аутентификации в модулях раздела «webui». Может быть получен в модуле «auth» по URL: /legacy/login. Наименование в заголовках запросов: X-Auth-Token;
• «healthTokenAuth» - токен для аутентификации в модулях раздела «health». Указывается в формате: Token <значение>. Значение токена определено в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf, в значении переменной HEALTH_CHECK_ACCESS_KEY.