Пригласительные ссылки#

API v2 позволяет получать, создавать и удалять пригласительные ссылки для конкретного устройства. Авторизация по токену описана в Настройке доступа

В пути server_id — ID устройства RuDesktop, а не внутренний числовой идентификатор записи базы данных. Устройство должно быть доступно владельцу токена. Передавать UUID устройства для этих методов не требуется

Права#

  • Для получения списка — Может видеть список пригласительных ссылок либо Может управлять пригласительными ссылками

  • Для создания и удаления — Может управлять пригласительными ссылками

Список ссылок также ограничен доступом пользователя к самим ссылкам. Наличие токена не даёт доступ ко всем устройствам и ссылкам сервера

По умолчанию пользователь видит свои ссылки. Право управления организацией добавляет ссылки её управляемых пользователей; право просмотра всех пригласительных ссылок расширяет список. Доступ к устройству всё равно требуется

Получение списка#

GET /api/v2/devices/{server_id}/invite-links/

Параметры page и page_size управляют постраничной выборкой. По умолчанию на странице 10 ссылок, максимум — 100

curl --header 'Authorization: Token [TOKEN]' \
    'https://[SERVER_ADDR]/api/v2/devices/[DEVICE_ID]/invite-links/?page=1&page_size=100'

Ответ содержит count, next, previous и список results. В записи ссылки возвращаются token, готовый адрес invite_url, server_id, отправитель, время действия, тип подключения, счётчики использований и ограничения доступа

Создание ссылки#

POST /api/v2/devices/{server_id}/invite-links/

Пример ссылки для одного подключения к рабочему столу в течение часа:

curl --request POST \
    --header 'Authorization: Token [TOKEN]' \
    --header 'Content-Type: application/json' \
    --data '{"expire_after_seconds":3600,"max_use_count":1,"invite_type":0}' \
    'https://[SERVER_ADDR]/api/v2/devices/[DEVICE_ID]/invite-links/'

Основные поля тела запроса:

  • expire_after_seconds — время действия в секундах: 900, 3600, 7200, 18000, 86400, 604800 или 2592000; null — без ограничения по времени

  • max_use_count — максимальное количество использований, не меньше 1; по умолчанию 1

  • invite_type — разрешённый тип подключения: 0 — рабочий стол, 1 — передача файлов, 3 — RDP, 5 — терминал

  • ask_for_connect — запрашивать пароль при подключении

  • host_group_id — числовой ID группы, определяющей права подключения

  • restrict_type — server, user или group; при выборе нужно также передать соответствующее поле restrict_to_server (ID устройства), restrict_to_user (ID пользователя) или restrict_to_group (ID группы)

Сервер назначает отправителем владельца токена и устанавливает начало действия при создании. Поля sender и date_create этим методом не задаются. При успехе возвращается код 201 и созданная ссылка с token и invite_url

Удаление ссылки#

DELETE /api/v2/devices/{server_id}/invite-links/{token}/

В пути использовать token из ответа API, а не числовой id ссылки

curl --request DELETE --header 'Authorization: Token [TOKEN]' \
    'https://[SERVER_ADDR]/api/v2/devices/[DEVICE_ID]/invite-links/[LINK_TOKEN]/'

При успехе возвращается 204 без тела ответа. После удаления ссылка не может использоваться для нового подключения

Сведения о параметрах и использовании ссылок доступны в руководстве пользователя