Роли¶

На этой странице представлены описания методов API, предназначенных для работы с ролями технических специалистов из раздела Команда.

Управление ролями¶

Список ролей¶

Получить список всех ролей, доступных для настройки прав доступа, можно с помощью метода /team/role/list.

Запрос:

HTTPcURL

GET /v1/team/role/list
  ?search=<string>
  &type=<string>
  &offset=<number>
  &limit=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/team/role/list" \
  --data-urlencode "search=<string>" \
  --data-urlencode "type=<string>" \
  --data-urlencode "offset=<number>" \
  --data-urlencode "limit=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметр	Тип	Описание
`search`	`string`	Фильтр по названию роли без учета регистра.
`type`	`string`	Тип роли. Список доступных значений приведен в справочнике ниже.
`offset`	`number`	Смещение относительно первого элемента списка. Значение по умолчанию: `0`.
`limit`	`number`	Количество элементов в списке. Значение по умолчанию: `20`; максимальное значение: `100`.

Ответ:

Пример ответа

Данные ответа

{
    "data": [ {
        "id": 1001,
        "name": "Аудитор",
        "type": "agent",
        "permission": [
            "agent_connect",
            "agent_control"
        ],
        "default": false
    } ]
}

Название	Тип	Описание
`id`	`number`	Внутренний системный идентификатор роли.
`name`	`string`	Название роли.
`type`	`string`	Тип роли. Список доступных значений приведен в справочнике ниже.
`permission[]`	`array`	Список прав. Список доступных значений приведен в справочнике ниже.
`default`	`boolean`	Признак того, что роль является системной.

Информация о роли¶

Получить информацию о конкретной роли можно с помощью метода team/role/info.

Запрос:

HTTPcURL

GET /v1/team/role/info
  ?id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/team/role/info" \
  --data-urlencode "id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Описание
`id`	`number`	Внутренний системный идентификатор роли.

Ответ:

Пример ответа

Данные ответа

{
    "data": {
        "id": 1000341,
        "name": "Уведомления",
        "type": "agent",
        "description": "Позволяет управлять устройствами и получать от них уведомления.",
        "default": false,
        "permission": [
            "agent_get_info",
            "agent_notification"
        ]
    }
}

Название	Тип	Описание
`id`	`number`	Внутренний системный идентификатор роли.
`name`	`string`	Название роли.
`type`	`string`	Тип роли. Список доступных значений приведен в справочнике ниже.
`description`	`string`	Краткое описание роли.
`default`	`boolean`	Признак того, что роль является системной.
`permission[]`	`array`	Список прав. Список доступных значений приведен в справочнике ниже.

Создание роли¶

Создать пользовательскую роль можно с помощью метода /team/role/create.

Запрос:

HTTPcURL

POST /v1/team/role/create
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "name": <string>,
  "description": <string>,
  "type": <string>,
  "permission": [ <string>, ... ]
}

curl -X POST "https://api.pro32connect.ru/v1/team/role/create" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "name": <string>,
    "description": <string>,
    "type": <string>,
    "permission": [ <string>, ... ]
  }'

Параметр	Тип	Описание
`name`	`string`	Название новой роли.
`description`	`string`	Описание роли.
`type`	`string`	Тип роли. Список доступных значений приведен в справочнике ниже.
`permission`	`array`	Список прав. Список доступных значений приведен в справочнике ниже.

Ответ:

Пример ответа

Данные ответа

{
    "status": 0
}

Название	Тип	Описание
`id`	`number`	Внутренний системный идентификатор созданной роли.
`status`	`number`	Статус выполнения. Возможные значения: `0` — Роль успешно создана. `1` — Некорректные данные запроса. `6` — Недостаточно прав.

Изменение роли¶

Изменить существующую пользовательскую роль можно с помощью метода /team/role/edit.

Запрос:

HTTPcURL

POST /v1/team/role/edit
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "name": <string>,
  "description": <string>,
  "permission": [ <string>, ... ]
}

curl -X POST "https://api.pro32connect.ru/v1/team/role/edit" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "name": <string>,
    "description": <string>,
    "permission": [ <string>, ... ]
  }'

Параметр	Тип	Описание
`id`	`number`	Идентификатор роли, которую необходимо изменить.
`name`	`string`	Новое название роли.
`description`	`string`	Описание роли.
`permission`	`array`	Список прав. Список доступных значений приведен в справочнике ниже.

Ответ:

Пример ответа

Данные ответа

{
    "status": 0
}

Название	Тип	Описание
`status`	`number`	Статус выполнения. Возможные значения: `0` — Роль успешно изменена. `1` — Некорректные данные запроса. `6` — Недостаточно прав.

Удаление роли¶

Удалить существующую пользовательскую роль можно с помощью метода /team/role/remove.

Запрос:

HTTPcURL

POST /v1/team/role/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/team/role/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'

Параметр	Тип	Описание
`id`	`number`	Идентификатор пользовательской роли, которую необходимо удалить.

Ответ:

Пример ответа

Данные ответа

{
    "status": 0
}

Название	Тип	Описание
`status`	`number`	Статус выполнения. Возможные значения: `0` — Роль успешно удалена. `1` — Некорректные данные запроса. `6` — Недостаточно прав.

Назначение ролей¶

Роли разделены на три категории в зависимости от их назначения. Набор доступных прав определяется типом роли.

Название	Идентификатор	Назначение
Устройства и группы	`agent` или `group`	Управление устройствами в разделе Постоянный доступ.
Приглашения	`quick_support`	Управление приглашениями в разделе Быстрая поддержка.
Администрирование	`team`	Администрирование Команды и ее настройками.

Права ролей¶

Права определяют функции, доступные для определенной роли. Набор доступных прав зависит от выбранного назначения.

Устройства и группыПриглашенияАдминистрирование

Название	ID	Описание
Действия		Доступные режимы подключения к устройству
Просмотр экрана	`agent_connect`	Разрешает подключение к экрану устройства в режиме просмотра
Управление экраном	`agent_control`	Разрешает управление экраном устройства с помощью мыши и клавиатуры
Файловый менеджер	`agent_file_transfer`	Разрешает подключение в файловой системе устройства
Режим терминала	`agent_terminal_mode`	Разрешает подключение в терминальном режиме
Пробуждение	`agent_wake_on_lan`	Разрешает пробуждение устройства с помощью Wake-on-LAN
Перезагрузка	`agent_reboot`	Разрешает перезагрузку удаленного устройства
Заблокировать/Разблокировать	`agent_lock_screen`	Разрешает блокировку учетной записи операционной системы на удаленном устройстве
Опции сессии		Функции, доступные во время удаленного сессии
Без подтверждения	`agent_no_confirm`	Разрешает не запрашивать подтверждение пользователя при подключении Работает только при подключении к устройствам, для которых требование подтверждения на подключение установлено через групповые настройки
Звонки	`agent_audio_calls`	Разрешает совершать звонки
Черный экран и блокировка ввода	`agent_lock_input`	Разрешает блокировать экран и средства ввода
Чат	`agent_chat`	Разрешает отправку текстовых сообщений
Синхронизация буфера обмена	`agent_clipboard`	Разрешает синхронизацию буфера обмена
Другие опции		Другие функции системы для устройств
Предпросмотр экрана	`agent_preview`	Разрешает просмотр превью экрана в списке устройств
История подключений	`agent_sessions`	Разрешает доступ к истории подключений
Инвентаризация ПО	`agent_program_list`	Разрешает доступ к информации об установленном ПО
Изменение устройства	`agent_change_settings`	Разрешает изменение свойств
Удаление устройства	`agent_logout`	Разрешает удаление устройств
Удаление видеозаписей	`agent_remove_video`	Разрешает удаление видеозаписей
Изменение уведомлений	`agent_notification`	Разрешает управление уведомлениями

Название	ID	Описание
Доступ к приглашениям		Определяет, какие приглашения доступны
Собственные приглашения	`quick_support_admin`	Разрешает доступ только к собственным приглашениям
Все приглашения	`quick_support_technical`	Разрешает доступ ко всем приглашениям команды
Действия		Доступные режимы подключения
Просмотр экрана	`agent_connect`	Разрешает подключение к экрану устройства в режиме просмотра
Управление экраном	`agent_control`	Разрешает подключение к экрану устройства в режиме управления мышью и клавиатурой
Файловый менеджер	`agent_file_transfer`	Разрешает подключение к файловой системе
Режим терминала	`agent_terminal_mode`	Разрешает подключение в терминальном режиме
Опции сессии		Функции, доступные во время подключения
Звонки	`agent_audio_calls`	Разрешает совершать звонки
Чат	`agent_chat`	Разрешает отправку текстовых сообщений
Перезагрузка	`agent_reboot`	Разрешает перезагрузку устройства
Запрос на установку	`agent_app_install_request`	Разрешает отправку запроса на установку приложения агента
Синхронизация буфера обмена	`agent_clipboard`	Разрешает синхронизацию буфера обмена
Другие опции		Другие функции
Превью экрана	`agent_preview`	Разрешает просмотр превью экрана
Удаление видеозаписей	`agent_remove_video`	Разрешает удаление видеозаписей

Название	ID	Описание
Функции администратора		Административные функции
Журнал аудита	`team_security_log_admin`	Разрешает доступ к журналам аудита команды
Настройки брендирования	`team_brand_admin`	Разрешает доступ к настройкам брендирования
Техники и настройки команды	`team_user_admin`	Разрешает управление техниками и настройками команды
Настройки оплаты	`team_billing_admin`	Разрешает управление оплатой
Ключи API	`team_api_key`	Разрешает управление API-ключами
Другие опции		Другие функции
Постоянный доступ	`team_permanent_access`	Предоставляет доступ к разделу Постоянный доступ. По умолчанию раздел доступен при наличии прав хотя бы на одно устройство или группу, но в некоторых случаях он может отсутствовать. Чтобы явно разрешить доступ к разделу Постоянный доступ, хотя бы для добавления нового устройства, предусмотрено это не совсем очевидное право.