Настройка доступа

Настройка доступа — описание процедуры подготовки пользователя для работы с REST API сервера RuDesktop: создание учётной записи, выпуск токена через команду rude token и пример использования токена в HTTP-запросах

Создание пользователя

Создайте отдельного пользователя для API (например, api_user) с помощью команды:

rude createsuperuser

Предупреждение

Команда создаёт суперпользователя. После создания обязательно ограничьте права через панель администратора, оставив только те права, которые необходимы для решаемых задач (например, просмотр устройств, управление группами и задачами)

Управление токенами

Команда rude token поддерживает три операции — создание, просмотр и отзыв токенов

Создание токена

Подробно — на странице команды token create

rude token create [имя_пользователя]

В ответе в стандартный вывод печатается значение токена. Сохраните его — повторно получить тот же токен будет нельзя

Важно

Для одного пользователя может существовать только один активный токен. При попытке создать второй токен команда вернёт ошибку Token already exists for this user. Чтобы перевыпустить токен — сначала отзовите существующий

Просмотр списка токенов

Подробно — на странице команды token list

rude token list

В выводе для каждого токена показаны: дата создания, имя пользователя и значение токена

Отзыв токена

Подробно — на странице команды token revoke

rude token revoke [значение_токена]

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

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

Полученный токен передаётся в заголовке Authorization каждого запроса:

curl --header "Authorization: Token [TOKEN]" https://[SERVER_ADDR]/api/peer/search/?hostname=XXXX

Примечание

Токен предоставляет API доступ от имени пользователя со всеми его правами. Храните токен как пароль — не передавайте его в открытом виде и не сохраняйте в публичных репозиториях