Интерфейс командной строки (CLI)¶

Установка¶

Утилита solidpoint-cli может быть установлена с помощью шагов, указанных ниже.

Важно

Все команды в инструкции запускаются пользователем с ролью «администратор».

GNU/LinuxDocker Compose

Добавьте репозиторий. При добавлении необходимо ввести секретный токен для получения доступа.
```
curl -fsSL repo.solidpoint.net | sh -
```
Установите CLI, используя пакетный менеджер.
```
apt install solidpoint-cli
```
Если используется многопользовательский режим, аутентифицируйтесь, используя следующую команду. Для однопользовательского режима аутентификация не требуется.
```
solidpoint-cli auth login -i
```

Загрузите дистрибутив. В настоящий момент дистрибутив предоставляется по запросу.

Выполните команду.

docker run --rm -it repo.solidpoint.net/solidpoint-cli

Переменные окружения¶

Утилита solidpoint-cli взаимодействует с переменными окружения, представленными в таблице ниже. Для данных переменных не задано значение по умолчанию, значения задаются с помощью команды solidpoint-cli auth login.

Переменная окружения	Описание
`SOLIDPOINT_BASE_URL`	URL-адрес серверной части, к которой необходимо подключиться. По умолчанию предлагается использовать `https://cloud.solidpoint.net`
`SOLIDPOINT_TOKEN`	Персональный токен доступа, который создаётся в панели управления. Служит для аутентификации

Аутентификация¶

При вводе любой команды пользователем осуществляется проверка необходимости аутентификации.

Если аутентификация не требуется, продолжается выполнение команды;
Если аутентификация требуется, автоматически вызывается команда login в интерактивном режиме. После успешного прохождения аутентификации продолжается выполнение основной команды.

Пример¶

❯ ./build/solidpoint-cli user list
You are not logged in. Redirecting to login...
SolidPoint instance URL: > http://localhost:8085
Email: > admin@solidpoint.local
Password:

User (admin@solidpoint.local) was successfully logged in
Re-running command...

Users:
 [
   ...
 ]

Использование¶

Утилита solidpoint-cli может использоваться следующим образом:

solidpoint-cli [flags]
solidpoint-cli [command]

Доступны следующие команды:

Команда	Описание
`about`	Вывод информации о текущей инсталляции
`auth`	Управление аутентификацией
`help`	Справка для любой команды
`instance`	Управление инсталляциями
`scan`	Управление сканированиями
`scanner`	Управление сканерами
`status`	Текущий статус CLI
`target`	Управление целями
`user`	Управление пользователями

Доступны следующие флаги:

-h, --help — справка для утилиты solidpoint-cli.

Команда `about`¶

Команда выводит информацию о текущей инсталляции SolidPoint.

solidpoint-cli about [flags]

Доступны следующие флаги:

-h, --help — справка для команды about.

Команда `auth`¶

Команда auth позволяет управлять аутентификацией. Она может использоваться следующим образом:

solidpoint-cli auth [flags]
solidpoint-cli auth [command]

Доступны следующие команды:

Команда	Описание
`login`	Осуществляет вход в систему
`logout`	Осуществляет выход из системы
`register`	Осуществляет регистрацию пользователя в системе

Доступны следующие флаги:

-h, --help — справка для команды auth.

Команда `login`¶

Команда login осуществляет вход в систему.

Использование¶

solidpoint-cli auth login [flags]

Флаги¶

Флаги	Тип	Описание
`-b`, `--base-url`	string	Адрес экземпляра сканера
`-e`, `--email`	string	Электронная почта пользователя
`-h`, `--help`	-	Справка для команды `login`
`-i`, `--interactive`	-	Интерактивный режим ввода
`-p`, `--password`	string	Пароль пользователя

Примеры использования¶

Запуск в интерактивном режиме:
```
solidpoint-cli auth login -i
```

Запуск без интерактивного режима:

solidpoint-cli auth login -b "https://cloud.solidpoint.net" -e "admin@solidpoint.local" -p "admin"

Команда `logout`¶

Команда logout осуществляет выход из системы.

Использование¶

solidpoint-cli auth logout [flags]

Флаги¶

-h, --help — справка для команды logout.

Команда `register`¶

Команда register осуществляет регистрацию пользователя в системе.

Использование¶

solidpoint-cli auth register [flags]

Флаги¶

Флаги	Тип	Описание
`-c`, `--company`	string	Название компании пользователя
`-e`, `--email`	string	Электронная почта пользователя
`-h`, `--help`	-	Справка для команды `register`
`-i`, `--interactive`	-	Интерактивный режим ввода
`-n`, `--name string`	string	Имя пользователя
`-o`, `--occupation string`	string	Должность пользователя
`-p`, `--password`	string	Пароль пользователя
`-t`, `--tenant string`	string	Название организации

Примеры использования¶

Запуск в интерактивном режиме:
```
solidpoint-cli auth register -i
```

Запуск без интерактивного режима:

solidpoint-cli auth register -t "test" -e "user@test.ru" -p "testPassword" -n "testName" -c "testCompany" -o "testOccupation"

Команда `help`¶

Команда help предоставляет справку для любой команды приложения. Она может использоваться следующим образом:

solidpoint-cli help [command] [flags]

Доступны следующие флаги:

-h, --help — справка для команды help.

Команда `instance`¶

Команда instance позволяет управлять инсталляциями. Она может использоваться следующим образом:

solidpoint-cli instance [flags]
solidpoint-cli instance [command]

Доступны следующие команды:

Команда	Описание
`add`	Добавляет новую инсталляцию
`delete`	Удаляет указанную инсталляцию
`list`	Выводит список доступных инсталляций
`rename`	Переименовывает указанную инсталляцию
`use`	Переключает на указанную инсталляцию

Доступны следующие флаги:

-h, --help — справка для команды instance.

Команда `add`¶

Команда add позволяет добавить новую инсталляцию SolidPoint. Она может использоваться следующим образом:

solidpoint-cli instance add [flags]

Доступны следующие флаги:

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `add`
`-i`, `--interactive`	-	Позволяет использовать команду в интерактивном режиме
`-n`, `--name`	string	Название инсталляции
`-u`, `--url`	string	URL-адрес инсталляции
`--use`	-	Позволяет переключиться на инсталляцию после её добавления

Примеры:

Добавление новой инсталляции:

solidpoint-cli instance add -u "https://cloud.solidpoint.net" -n "instanceName"

Добавление новой инсталляции и переключение на неё:
```
solidpoint-cli instance add -u "https://cloud.solidpoint.net" -n "instanceName" --use
```

Команда `delete`¶

Команда delete позволяет удалить указанную инсталляцию SolidPoint. Она может использоваться следующим образом:

solidpoint-cli instance delete [instance URL/name] [flags]

Доступны следующие флаги:

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `delete`
`-i`, `--interactive`	-	Позволяет использовать команду в интерактивном режиме

Примеры:

Удаление инсталляции по URL-адресу:

solidpoint-cli instance delete "https://cloud.solidpoint.net"

Удаление инсталляции по имени:
```
solidpoint-cli instance delete "instanceName"
```

Команда `list`¶

Команда list выводит информацию о доступных инсталляциях SolidPoint. Она может использоваться следующим образом:

solidpoint-cli instance list [flags]

Доступны следующие флаги:

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `list`

Команда `rename`¶

Команда rename переименовывает указанную инсталляцию SolidPoint. Она может использоваться следующим образом:

solidpoint-cli instance rename [instance URL/name] [flags]

Доступны следующие флаги:

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `rename`
`-i`, `--interactive`	-	Позволяет использовать команду в интерактивном режиме
`-n`, `--name`	string	Название инсталляции

Примеры:

Переименование инсталляции по URL-адресу:

solidpoint-cli instance rename "https://cloud.solidpoint.net" --name "newName"

Переименование инсталляции по имени:

solidpoint-cli instance rename "instanceName" --name "newName"

Команда `use`¶

Команда use позволяет переключиться на указанную инсталляцию SolidPoint. Она может использоваться следующим образом:

solidpoint-cli instance use [instance URL/name] [flags]

Доступны следующие флаги:

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `use`
`-i`, `--interactive`	-	Позволяет использовать команду в интерактивном режиме

Примеры:

Переключение на инсталляцию по URL-адресу:
```
solidpoint-cli instance use "https://cloud.solidpoint.net"
```

Переключение на инсталляцию по имени:
```
solidpoint-cli instance use "instanceName"
```

Команда `scan`¶

Команда scan позволяет управлять сканированиями. Она может использоваться следующим образом:

solidpoint-cli scan [flags]
solidpoint-cli scan [command]

Доступны следующие команды:

Команда	Описание
`cancel`	Завершает сканирование
`new`	Запускает новое сканирование
`new-ci`	Запускает новое сканирование для непрерывной интеграции
`show`	Предоставляет различную информацию о сканировании
`status`	Отображает статус сканирования

Доступны следующие флаги:

-h, --help — справка для команды scan.

Команда `cancel`¶

Команда cancel завершает сканирование.

Использование¶

solidpoint-cli scan cancel [scan_id] [flags]

Флаги¶

-h, --help справка для команды cancel

Команда `new`¶

Команда new запускает новое сканирование.

Использование¶

solidpoint-cli scan new [flags]

Флаги¶

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `new`
`-m`, `--module`	strings	Модуль сканирования
`-i`, `--targetID`	uint32	Идентификатор цели
`-u`, `--url`	string	URL-адрес сканируемого приложения

Примеры использования¶

Запуск сканирования с использованием флага -i:
```
solidpoint-cli scan new -i 1
```

Запуск сканирования с использованием флага -u:
```
solidpoint-cli scan new -u "http://test.test"
```

Запуск сканирования с указанными модулями:

solidpoint-cli scan new -u "http://test.test" -m "module-name-1" -m "module-name-2"

Команда `new-ci`¶

Команда new-ci запускает новое сканирование для непрерывной интеграции. Транслирует статус сканирования в реальном времени. Команда завершается с ненулевым кодом возврата, если был найден хотя бы один недостаток.

Использование¶

solidpoint-cli scan new-ci [flags]

Флаги¶

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `new-ci`
`-m`, `--module`	strings	Модуль сканирования
`-s`, `--severity`	string	Уровень критичности уязвимости, при выявлении которого сканирование будет завершено с ошибкой. Допустимые значения: `info`, `low`, `medium`, `high`, `critical`
`-i`, `--targetID`	uint32	Идентификатор цели
`-u`, `--url`	string	URL-адрес сканируемого приложения

Примеры использования¶

Запуск сканирования с использованием флага -i:
```
solidpoint-cli scan new-ci -i 1
```

Запуск сканирования с использованием флага -u:
```
solidpoint-cli scan new-ci -u "http://test.test"
```

Запуск сканирования с указанием допустимого уровня критичности уязвимости:
```
solidpoint-cli scan new-ci -u "http://test.test" -s [severity_value]
```

Запуск сканирования для непрерывной интеграции с указанными модулями:
```
solidpoint-cli scan new-ci -u "http://test.test" -m "module-name-1" -m "module-name-2"
```

Команда `show`¶

Команда show предоставляет различную информацию об указанном сканировании.

Использование¶

solidpoint-cli scan show [command] [scan_id] [flags]

Команды¶

Команда	Описание	Доступные флаги	Описание флага
`app-auth`	Информация об аутентификации в приложении	`-h`, `--help`	Справка для команды `app-auth`
`deps`	Информация о конечных точках	`-h`, `--help`	Справка для команды `deps`
`deps`	Информация о конечных точках	`--issues-only`	Отображать данные только для конечных точек с уязвимостями
`details`	Детализация	`-h`, `--help`	Справка для команды `details`
		`--issues-only`	Отображать данные только для конечных точек с уязвимостями
		`--raw`	Вывести технический отчёт
		`--short`	Вывести информацию без ресурсов и данных конечных точек
`issues`	Информация об уязвимостях	`-h`, `--help`	Справка для команды `issues`
`issues`	Информация об уязвимостях	`-s`, `--severity`	Уровень критичности (`info`, `low`, `medium`, `high`, `critical`)
`jobs`	Информация о задачах сканирования	`-h`, `--help`	Справка для команды `jobs`
`resources`	Информация о ресурсах	`-h`, `--help`	Справка для команды `resources`
`resources`	Информация о ресурсах	`--issues-only`	Отображать данные только для конечных точек с уязвимостями

Команда `status`¶

Команда status отображает статус сканирования.

Использование¶

solidpoint-cli scan status [scan_id] [flags]

Флаги¶

-d, --detailed — детальное описание уязвимостей
-h, --help — справка для команды status

Примеры использования¶

Запрос статуса сканирования (scan_id = 1):
```
solidpoint-cli scan status 1
```

Команда `scanner`¶

Команда scanner позволяет управлять сканерами. Она может использоваться следующим образом:

solidpoint-cli scanner [flags]
solidpoint-cli scanner [command]

Доступны следующие команды:

Команда	Описание
`new`	Создаёт новый сканер
`info`	Выводит информацию о сканере (его параметрах и модулях)
`enable`	Включает сканер
`disable`	Выключает сканер

Доступны следующие флаги:

-h, --help — справка для команды scanner.

Команда `new`¶

Команда new позволяет создать новый сканер.

Использование¶

solidpoint-cli scanner new [flags]

Флаги¶

Флаг	Тип	Описание
`-a`, `--address`	string	Позволяет указать адрес сканера
`-n`, `--name`	string	Позволяет указать имя сканера
`-i`, `--interactive`	-	Позволяет использовать команду в интерактивном режиме
`-h`, `--help`	-	Справка для команды `new`

Команда `info`¶

Команда info позволяет получить информацию о сканере (его параметрах и модулях).

Использование¶

solidpoint-cli scanner info [scanner_id] [flags]

Флаги¶

-h, --help — справка для команды info.

Команда `enable`¶

Команда enable позволяет включить сканер.

Использование¶

solidpoint-cli scanner enable [scanner_id] [flags]

Флаги¶

-h, --help — справка для команды enable.

Команда `disable`¶

Команда disable позволяет выключить сканер.

Использование¶

solidpoint-cli scanner disable [scanner_id] [flags]

Флаги¶

-h, --help — справка для команды disable.

Команда `status`¶

Команда status отображает текущий статус CLI. Она может использоваться следующим образом:

solidpoint-cli status [flags]

Доступны следующие флаги:

-h, --help — справка для команды scan.

Команда `target`¶

Команда target позволяет управлять целями. Она может использоваться следующим образом:

solidpoint-cli target [flags]
solidpoint-cli target [command]

Доступны следующие команды:

Команда	Описание
`clear-app-auth`	Удаляет данные для аутентификации целевого приложения
`new`	Создает новую цель
`show-app-auth`	Предоставляет информацию об аутентификации целевого приложения
`update`	Обновляет цель или цели

Доступны следующие флаги:

-h, --help — справка для команды target.

Команда `clear-app-auth`¶

Команда clear-app-auth удаляет данные для аутентификации целевого приложения

Использование¶

solidpoint-cli target clear-app-auth [target_id] [flags]

Флаги¶

-h, --help — справка для команды clear-app-auth.

Примеры использования¶

Удаление данных для аутентификации целевого приложения с target_id = 1 :
```
solidpoint-cli target clear-app-auth 1
```

Команда `new`¶

Команда new создает новую цель.

Использование¶

solidpoint-cli target new [flags]

Флаги¶

Флаги	Тип	Описание
`-d`, `--description`	string	Описание цели
`-h`, `--help`	-	Справка для команды `new`
`-i`, `--interactive`	-	Интерактивный режим ввода
`-n`, `--name`	string	Название цели
`-u`, `--url`	string	URL-адрес цели

Примеры использования¶

Запуск в интерактивном режиме:
```
solidpoint-cli target new -i
```

Запуск без интерактивного режима:

solidpoint-cli target new -u "target URL" -n "target name" -d "target description"

Команда `show-app-auth`¶

Команда show-app-auth предоставляет информацию об аутентификации целевого приложения.

Использование¶

solidpoint-cli target show-app-auth [target_id] [flags]

Флаги¶

-h, --help — справка для команды show-app-auth.

Примеры использования¶

Получение информации об аутентификации целевого приложения с target_id = 1
```
solidpoint-cli target show-app-auth 1
```

Команда `update`¶

Команда update обновляет цель или цели.

Использование¶

solidpoint-cli target update [flags]
solidpoint-cli target update [command]

Команды¶

Команда	Описание
`app-auth`	Обновляет аутентификационные данные целевого приложения
`auth-checker`	Обновляет конфигурацию механизма проверки аутентификации
`browser-auth-refresher`	Обновляет конфигурацию механизма обновления аутентификационных данных с помощью браузерного сценария
`regexp-auth-refresher`	Обновляет конфигурацию механизма обновления аутентификационных данных с помощью HTTP-запроса

Команда `app-auth`¶

Команда app-auth обновляет аутентификационные данные целевого приложения.

Использование¶

solidpoint-cli target update app-auth [command] [flags]

Используйте следующие команды и соответствующие флаги, чтобы выбрать нужный тип аутентификации и параметры для команды app-auth:

Команда	Описание	Флаги
`cookies`	Обновляет аутентификационные данные с использованием cookies целевого приложения. Количество имен хостов и cookie должно быть одинаковым, пустое имя хоста означает, что cookie будет содержать имя целевого хоста. Если необходимо передать путь, укажите его с параметром `hostname`: test.test + /test = test.test/test. Эта команда по умолчанию перезаписывает все cookie для проверки подлинности целевого приложения. Если необходимо добавить cookie, используйте флаг `-a` (`--add`). Флаг `-r` (`--rewrite`) предназначен для перезаписи всех данных проверки подлинности приложения только с помощью cookie	`-a`, `--add` — добавить `-v`, `--cookie` string — cookie `-h`, `--help` — справка для `headers` `-n`, `--hostname` string — имя хоста `-r`, `--rewrite` — перезаписать
`headers`	Обновляет аутентификационные данные с использованием заголовков. Количество узлов и заголовков должно быть равным, пустой узел означает, что в заголовке будет указан узел хоста. Если необходимо передать путь, укажите его с параметром `host`: test.test + /test = test.test/test ИЛИ test.test:5000 + /test = test.test:5000/test. Эта команда по умолчанию перезаписывает все заголовки проверки подлинности целевого приложения. Если необходимо добавить заголовки, используйте флаг `-a` (`--add`). Флаг `-r` (`--rewrite`) предназначен для перезаписи всех данных проверки подлинности приложения только заголовками	`-a`, `--add` — добавить `-v`, `--header` string — заголовок `-h`, `--help` — справка для `headers` `-n`, `--hostname` string — имя хоста `-r`, `--rewrite` — перезаписать
`http-basic-auth`	Обновляет аутентификационные данные с использованием базовой HTTP-аутентификации. Если необходимо добавить базовую аутентификацию по протоколу HTTP, используйте флаг `-a` (`--add`). Флаг `-r` (`--rewrite`) предназначен для перезаписи всех данных аутентификации приложений только с использованием базовой аутентификации по протоколу HTTP	`-a`, `--add` — добавить `-h`, `--help` — справка для `http-basic-auth` `-r`, `--rewrite` — перезаписать
`tls`	Эта команда по умолчанию перезаписывает аутентификацию всех целевых приложений по протоколу TLS. Если необходимо добавить аутентификацию приложений по протоколу TLS, используйте флаг `-a` (`--add`). Флаг `-r` (`--rewrite`) предназначен для перезаписи всех данных аутентификации приложений, используя только аутентификацию приложений по протоколу TLS	`-a`, `--add` — добавить; `-c`, `--certificate` string — файл сертификата; `-h`, `--help` — справка для `tls`; `-k`, `--key` string — файл ключа `-r`, `--rewrite` — перезаписать

Флаги¶

-h, --help — справка для команды app-auth.

Примеры использования¶

Переписать или добавить cookie для аутентификации целевого приложения:
```
solidpoint-cli target update app-auth cookies 1 -v name=value
```

Добавить cookie для аутентификации целевого приложения:
```
solidpoint-cli target update app-auth cookies 1 -a -v name2=value2
```

Переписать или добавить cookie для аутентификации целевого приложения с указанием хоста:
```
solidpoint-cli target update app-auth cookies 1 -n test.test -v name=value
```

Переписать или добавить cookie для аутентификации целевого приложения с указанием хоста и пути:
```
solidpoint-cli target update app-auth cookies 1 -n test.test/test -v name=value
```

Переписать или добавить cookie для аутентификации целевого приложения с указанием нескольких хостов и путей:
```
solidpoint-cli target update app-auth cookies 1 -n test.test/test -v name=value -n test2.test/test -v name2=value2
```

Переписать данные аутентификации целевого приложения только с помощью cookie:
```
solidpoint-cli target update app-auth cookies 1 -r -v name=value
```

Переписать или добавить заголовки проверки подлинности целевого приложения:
```
solidpoint-cli target update app-auth headers 1 -v Name=Value
```

Добавить заголовки проверки подлинности целевого приложения:
```
solidpoint-cli target update app-auth headers 1 -a -v Name2=Value2
```

Добавить заголовки проверки подлинности целевого приложения с помощью host:
```
solidpoint-cli target update app-auth headers 1 -n test.test -v Name=Value
```

Добавить заголовки проверки подлинности целевого приложения с указанием узла и пути:
```
solidpoint-cli target update app-auth headers 1 -n test.test/test -v Name=Value
```

Добавить заголовки проверки подлинности целевого приложения с указанием нескольких узлов и путей:
```
solidpoint-cli target update app-auth headers 1 -n test.test/test -v Name=Value -n test2.test:5000/test -v Name2=Value2
```

Переписать данные проверки подлинности целевого приложения, используя только заголовки:
```
solidpoint-cli target update app-auth headers 1 -r -v Name=Value
```

Переписать или добавить базовую HTTP-аутентификацию целевого приложения:
```
solidpoint-cli target update app-auth http-basic-auth 1
```

Добавить базовую HTTP-аутентификацию целевого приложения:
```
solidpoint-cli target update app-auth http-basic-auth 1 -a
```

Переписать данные проверки подлинности целевого приложения, используя только базовую HTTP-аутентификацию:
```
solidpoint-cli target update app-auth http-basic-auth 1 -r
```

Переписать или добавить TLS-аутентификацию целевого приложения:
```
solidpoint-cli target update app-auth tls 1 -c /path/to/cert/file.crt -k /path/to/key/file.key
```

Добавить TLS-аутентификацию целевого приложения:

solidpoint-cli target update app-auth tls 1 -a -c /path/to/cert/file.crt -k /path/to/key/file.key

Переписать данные проверки подлинности целевого приложения, используя только TLS:
```
solidpoint-cli target update app-auth tls 1 -r -c /path/to/cert/file.crt -k /path/to/key/file.key
```

Команда `auth-checker`¶

Команда auth-checker обновляет конфигурацию механизма проверки аутентификации.

Использование¶

solidpoint-cli target update auth-checker [target_id] [flags]

Флаги¶

Флаги	Тип	Описание
`-c`, `--config`	string	Конфигурация в формате JSON
`-e`, `--enabled`	boolean	Включает механизм проверки аутентификации
`-f`, `--file`	string	Путь к файлу конфигурации
`-h`, `--help`	-	Справка для команды `auth-checker`
`-r`, `--rewrite`	string	Перезаписывает данные конфигурации, игнорируя любые существующие значения, или полностью удаляет их

Примеры использования¶

Обновить конфигурацию механизма проверки аутентификации с помощью объекта в формате JSON:
```
solidpoint-cli target update auth-checker 1 -c '{"key":"value"}'
```

Обновить конфигурацию механизма проверки аутентификации с помощью файла в формате JSON:
```
solidpoint-cli target update auth-checker 1 -f "/path/to/config.json"
```

Включить проверку аутентификации:
```
solidpoint-cli target update auth-checker 1 -e
```

Отключить проверку аутентификации:
```
solidpoint-cli target update auth-checker 1 -e=false
```

Обновить конфигурацию механизма проверки аутентификации и включить проверку аутентификации:
```
solidpoint-cli target update auth-checker 1 -c '{"key":"value"}' -e
```

Удалить конфигурацию механизма проверки аутентификации:
```
solidpoint-cli target update auth-checker 1 -r
```

Команда `browser-auth-refresher`¶

Обновляет конфигурацию механизма обновления аутентификационных данных с помощью браузерного сценария.

Использование¶

solidpoint-cli target update browser-auth-refresher [target_id] [flags]

Флаги¶

Флаги	Тип	Описание
`-c`, `--config`	string	Конфигурация в формате JSON
`-e`, `--enabled`	boolean	Включает механизм обновления аутентификационных данных с помощью браузерного сценария
`-f`, `--file`	string	Путь к файлу конфигурации
`-h`, `--help`	-	Справка для команды `browser-auth-refresher`
`-r`, `--rewrite`	string	Перезаписывает данные конфигурации, игнорируя любые существующие значения, или полностью удаляет их

Примеры использования¶

Обновить конфигурацию механизма обновления аутентификационных данных с помощью браузерного сценария, используя объект в формате JSON:
```
solidpoint-cli target update browser-auth-refresher 1 -c '{"key":"value"}'
```

Обновить конфигурацию механизма обновления аутентификационных данных с помощью браузерного сценария, используя файл в формате JSON:
```
solidpoint-cli target update browser-auth-refresher 1 -f "/path/to/config.json"
```

Включить обновление аутентификации:
```
solidpoint-cli target update browser-auth-refresher 1 -e
```

Отключить обновление аутентификации:

solidpoint-cli target update browser-auth-refresher 1 -e=false

Обновить конфигурацию механизма обновления аутентификационных данных с помощью браузерного сценария и включить обновление аутентификации:
```
solidpoint-cli target update browser-auth-refresher 1 -c '{"key":"value"}' -e
```

Удалить конфигурацию механизма обновления аутентификационных данных с помощью браузерного сценария:
```
solidpoint-cli target update browser-auth-refresher 1 -r
```

Команда `regexp-auth-refresher`¶

Обновляет конфигурацию механизма обновления аутентификационных данных с помощью HTTP-запроса.

Использование¶

solidpoint-cli target update regexp-auth-refresher [target_id] [flags]

Флаги¶

Флаги	Тип	Описание
`-c`, `--config`	string	Конфигурация в формате JSON
`-e`, `--enabled`	boolean	Включает механизм обновления аутентификационных данных с помощью HTTP-запроса
`-f`, `--file`	string	Путь к файлу конфигурации
`-h`, `--help`	-	Справка для команды `regexp-auth-refresher`
`-r`, `--rewrite`	string	Перезаписывает данные конфигурации, игнорируя любые существующие значения, или полностью удаляет их

Примеры использования¶

Обновить конфигурацию механизма обновления аутентификационных данных с помощью HTTP-запроса, используя объект в формате JSON:
```
solidpoint-cli target update regexp-auth-refresher 1 -c '{"key":"value"}'
```

Обновить конфигурацию механизма обновления аутентификационных данных с помощью HTTP-запроса, используя файл в формате JSON:
```
solidpoint-cli target update regexp-auth-refresher 1 -f "/path/to/config.json"
```

Включить обновление аутентификации:
```
solidpoint-cli target update regexp-auth-refresher 1 -e
```

Отключить обновление аутентификации:
```
solidpoint-cli target update regexp-auth-refresher 1 -e=false
```

Обновить конфигурацию механизма обновления аутентификационных данных с помощью HTTP-запроса и включить обновление аутентификации:
```
solidpoint-cli target update regexp-auth-refresher 1 -c '{"key":"value"}' -e
```

Удалить конфигурацию механизма обновления аутентификационных данных с помощью HTTP-запроса:
```
solidpoint-cli target update regexp-auth-refresher 1 -r
```

Команда `user`¶

Команда user позволяет управлять пользователями. Она может использоваться следующим образом:

solidpoint-cli user [flags]
solidpoint-cli user [command]

Доступны следующие команды:

Команда	Описание
`activate`	Активирует одного пользователя
`activate-all`	Активирует всех пользователей
`list`	Выводит список пользователей

Доступны следующие флаги:

-h, --help — справка для команды user.

Команда `activate`¶

Использование¶

solidpoint-cli user activate [flags]

Флаги¶

Флаги	Тип	Описание
`-h`, `--help`	-	Справка для команды `activate`
`-i`, `--interactive`	-	Интерактивный ввод
`-r`, `--role`	string	Задаёт пользователю роль из списка: `user` (по умолчанию), `admin`, `superAdmin`
`-t`, `--tenant`	string	ID или имя тенанта (может быть пустым для тенанта по умолчанию)
`-u`, `--user`	string	ID или email пользователя

Примеры использования¶

Интерактивный ввод:
```
solidpoint-cli user activate -i
```

Активация пользователя по ID:
```
solidpoint-cli user activate -u "1"
```

Активация пользователя по email:
```
solidpoint-cli user activate -u "user@test.ru"
```

Активация пользователя по ID в определенном тенанте с определенной ролью (тенант — test, роль — admin):
```
solidpoint-cli user activate -u "1" -t "test" -r "admin"
```

Активация пользователя по email в определенном тенанте с определенной ролью (тенант — test, роль — admin):
```
solidpoint-cli user activate -u "user@test.ru" -t "test" -r "admin"
```

Команда `activate-all`¶

Все пользователи во всех тенантах будут активированы, если тенант не указан или пуст. Если у тенанта по умолчанию нет имени и необходимо активировать в нём всех пользователей, то следует указать идентификатор.

Все пользователи в конкретном тенанте будут активированы, если тенант указан или не пуст.

Использование¶

solidpoint-cli user activate-all [flags]

Флаги¶

Флаги	Описание
`-h`, `--help`	Справка для команды `activate-all`
`-i`, `--interactive`	Интерактивный ввод
`-r`, `--role string`	Задаёт пользователям роль из списка: `user` (по умолчанию), `admin`, `superAdmin`
`-t`, `--tenant string`	ID или имя тенанта (может быть пустым для тенанта по умолчанию)

Примеры использования¶

Интерактивный ввод:
```
solidpoint-cli user activate-all -i
```

Активация всех пользователей во всех тенантах:
```
solidpoint-cli user activate-all
```

Активация всех пользователей в тенанте по умолчанию:
```
solidpoint-cli user activate-all -t "1"
```

Активация всех пользователей в определенном тенанте (тенант — test):
```
solidpoint-cli user activate-all -t "test"
```

Активация всех пользователей в определенном тенанте с определенной ролью (тенант — test, роль — user):
```
solidpoint-cli user activate-all -t "test" -r "user"
```

Команда `list`¶

Использование¶

solidpoint-cli user list [flags]

Флаги¶

Флаги	Описание
`-h`, `--help`	Справка для команды `list`
`-r`, `--role string`	Пользовательская роль из списка: `user`, `admin`, `superAdmin`, `unknown`
`-t`, `--tenant string`	ID или имя тенанта

Примеры использования¶

Список всех пользователей во всех тенантах:
```
solidpoint-cli user list
```

Список всех пользователей с опреленной ролью (роль — unknown):
```
solidpoint-cli user list -r "unknown"
```

Список всех пользователей в определенном тенанте (тенант — test):
```
solidpoint-cli user list -t "test"
```

Список всех пользователей в определенном тенанте с определенной ролью (тенант — test, роль — unknown):
```
solidpoint-cli user list -t "test" -r "unknown"
```

Интерфейс командной строки (CLI)¶

Установка¶

Переменные окружения¶

Аутентификация¶

Пример¶

Использование¶

Команда about¶

Команда auth¶

Команда login¶

Использование¶

Флаги¶

Примеры использования¶

Команда logout¶

Использование¶

Флаги¶

Команда register¶

Использование¶

Флаги¶

Примеры использования¶

Команда help¶

Команда instance¶

Команда add¶

Команда delete¶

Команда list¶

Команда rename¶

Команда use¶

Команда scan¶

Команда cancel¶

Использование¶

Флаги¶

Команда new¶

Использование¶

Флаги¶

Примеры использования¶

Команда new-ci¶

Использование¶

Флаги¶

Примеры использования¶

Команда show¶

Использование¶

Команды¶

Команда status¶

Использование¶

Флаги¶

Примеры использования¶

Команда scanner¶

Команда new¶

Использование¶

Флаги¶

Команда info¶

Использование¶

Флаги¶

Команда enable¶

Использование¶

Флаги¶

Команда disable¶

Использование¶

Флаги¶

Команда status¶

Команда target¶

Команда clear-app-auth¶

Использование¶

Флаги¶

Примеры использования¶

Команда new¶

Использование¶

Флаги¶

Примеры использования¶

Команда show-app-auth¶

Использование¶

Флаги¶

Примеры использования¶

Команда update¶

Использование¶

Команды¶

Команда app-auth¶

Использование¶

Флаги¶

Примеры использования¶

Команда auth-checker¶

Команда `about`¶

Команда `auth`¶

Команда `login`¶

Команда `logout`¶

Команда `register`¶

Команда `help`¶

Команда `instance`¶

Команда `add`¶

Команда `delete`¶

Команда `list`¶

Команда `rename`¶

Команда `use`¶

Команда `scan`¶

Команда `cancel`¶

Команда `new`¶

Команда `new-ci`¶

Команда `show`¶

Команда `status`¶

Команда `scanner`¶

Команда `new`¶

Команда `info`¶

Команда `enable`¶

Команда `disable`¶

Команда `status`¶

Команда `target`¶

Команда `clear-app-auth`¶

Команда `new`¶

Команда `show-app-auth`¶

Команда `update`¶

Команда `app-auth`¶

Команда `auth-checker`¶

Команда `browser-auth-refresher`¶

Команда `regexp-auth-refresher`¶

Команда `user`¶

Команда `activate`¶

Команда `activate-all`¶

Команда `list`¶