Вход администратора в систему
По умолчанию пароль администратора – admin.
После выполнения команды браузер автоматически сохраняет cookie с именем gcccookie, в котором хранится токен авторизации.
Далее cookie автоматически отправляется браузером для всех последующих команд.
Авторизация не требуется.
Входные параметры RAW JSON:
POST /v1.0/lm/login
{
"loginPass" : "admin",
"loginRememberMe" : tru
}
Смена пароля администратора
Требуется авторизация.
Входные параметры RAW JSON:
POST /v1.0/lm/newpassword
{
"newPassword" : "admin",
"loginRememberMe" : true
}
Обновление токена авторизации
Требуется авторизация.
Входных параметров нет.
POST /v1.0/lm/refreshauthtoken
Выход администратора из системы
Требуется авторизация.
Входных параметров нет.
POST /v1.0/lm/logout
Обновление настроек
По умолчанию адрес сервиса активации для Guardant Station Cloud – https://getlicense.guardant.ru:443, для Guardant Station Retail (BOX) – https://localhost:9000.
Сохраняются только настройки, которые присутствуют в запросе. Остальные настройки не меняются.
Описание параметров настроек:
allowAutoDetach– разрешить/запретить автоматическое открепление лицензий;allowDetach– разрешить/запретить открепление лицензий;autoRefreshLocalDonglesTimeout– таймаут автоматической загрузки лицензий из локальных ключей в память менеджера лицензий (в минутах);autoRefreshRemoteDonglesTimeout– таймаут автоматической загрузки лицензий из ключей, расположенных в локальной сети, в память менеджера лицензий (в минутах);broadcastRemoteLicenses– использовать широковещательный поиск;getLicenseUrl– адрес сервера активации;keepAlive– поддержка активности TCP включена или отключена;keepAliveTime– указывает тайм-аут (в миллисекундах) без активности, пока не будет отправлен первый пакет проверки активности;keepAliveInterval– указывает интервал (в миллисекундах) между отправкой последовательных пакетов проверки активности, если подтверждение не получено;logLevel– текущий уровень логирования. По умолчанию используется уровень логирования NOTICE (5);- l
ogRotationSize– максимальный размер лог-файла (в мегабайтах); logPurgeCount– количество хранимых файлов;logAssociatedTags– шаблон строки для форматирования событий бизнес-логики при записи в лог-файл;logTags– массив имён допустимых тегов логирования с их описанием;maxAutoDetachHours– максимальный период автоматического открепления лицензии (в часах);maxDetachDays– максимальный период открепления лицензии (в днях);offlineDetachAdminRequired– требовать авторизацию для открепления лицензии на другие компьютеры;remotehosts– дополнительный список адресов для поиска лицензий;showRemoteLicenses– показывать сетевые лицензии с других серверов в локальной сети;showRemoteSessions– показывать сессии с других компьютеров в локальной сети;useRemoteHosts– использовать дополнительный список адресов для поиска лицензий;userRestrictionRules– правила ограничения доступа к лицензиям.
Подробную информацию об уровнях логирования (параметр logLevel) см. на странице Логирование.
Подробную информацию о правилах ограничения доступа (параметр userRestrictionRules) см. на странице Правила ограничения доступа.
Требуется авторизация.
Входные параметры RAW JSON:
PUT /v1.0/lm/settings
{
"showRemoteLicenses" : "1",
"broadcastRemoteLicenses" : 0,
"remotehosts" : ["test-pc"],
"useRemoteHosts": 1
}
Получение текущих настроек
GET /v1.0/lm/settings
Возвращает значение:
{
"allowAutoDetach": 0,
"allowDetach": 0,
"autoRefreshLocalDonglesTimeout": 2,
"autoRefreshRemoteHostsTimeout": 2,
"broadcastRemoteLicenses" : 1,
"getLicenseUrl": "https://getlicense.guardant.ru",
"keepAlive" : 1,
"keepAliveTime" : 7200000,
"keepAliveInterval" : 1000,
"logAssociatedTags": "sessionid={sessionid} apiname='{apiname}' apiversion={apiversion} result='{result}' ip={clientaddr} user={clientid} licenseid={licenseid} productid={productid} featureid= {featureid} seats={seats}",
"logLevel": 6,
"logPurgeCount": 100,
"logRotationSize": 1,
"logTags": [
{
"description": "API function name",
"name": "{apiname}"
},
{
"description": "API version",
"name": "{apiversion}"
}
],
"maxAutoDetachHours": 2,
"maxDetachDays" : 10,
"offlineDetachAdminRequire": 1,
"remotehosts" : ["test-pc", "new-pc"],
"showRemoteSessions" : 0,
"showRemoteLicenses" : 0,
"useRemoteHosts": 1,
"userRestrictionRules": [
"deny=*@b2291-pc",
"allow=bma@b2291-pc,feature:0"
]
}
Сброс текущих настроек на значения по умолчанию
Требуется авторизация.
Входные параметры RAW JSON:
POST /v1.0/lm/settings/setdefault
По умолчанию адрес сервиса активации для Guardant Station Cloud – https://getlicense.guardant.ru:443, для Guardant Station Retail (BOX) – https://localhost:9000.
Сбрасывает все настройки на значения по умолчанию. Возвращает новые значения для всех настроек.
Сброс текущих настроек логирования на значения по умолчанию
Требуется авторизация.
Входные параметры RAW JSON:
POST /v1.0/lm/settings/logtags/setdefault
Сбрасывает только шаблон строки для форматирования событий бизнес-логики в значение по умолчанию. Возвращает новые значения для всех настроек.
Получение пользовательских настроек доступа
GET /v1.0/lm/settings/user_restrictions?search=text_or_value_for_search
Доступен поиск по идентификатору лицензии, номеру/имени продукта, номеру/имени компонента, вендору, имени компьютера и имени пользователя.
Возвращает значение:
{
"userRestrictions": [
{
"hostName": "b2291-pc",
"rule": 0
},
{
"featureName": "Главный уровень защиты",
"featureNumber": 0,
"hostName": "b2291-pc",
"rule": 1,
"userName": "bma"
}
]
}
Сбрасывает только шаблон строки для форматирования событий бизнес-логики в значение по умолчанию. Возвращает новые значения для всех настроек.