Справочник объектов и условий политик
Статья — практический справочник для Редактора политик: какие субъекты, объекты и действия можно выбрать в правиле, какие атрибуты у них есть, как писать дополнительные условия и как работают алгоритмы комбинирования.
Теория дерева политик описана в статье Базовые понятия, грамматика языка выражений — в статье Выражения. Перечень на этой странице соответствует реализации в версии 10.8.
N.B.
В конструкторе правила поля Кто делает запрос, Над чем запрос и Действие собирают только простые проверки (тип, роль, ключ функции и т. п.). Всё, что сравнивает две сущности, обращается к окружению (env.*) или вызывает функцию, нужно писать вручную в поле Дополнительные условия. Синтаксис этого поля в интерфейсе не подсказывается.
Как устроено правило в редакторе
При проверке доступа система вычисляет выражения в контексте запроса. В выражениях доступны четыре группы атрибутов:
| Группа | Префикс | Что означает | Поле в редакторе правила |
|---|---|---|---|
| Субъект | subj |
Кто выполняет действие | Кто делает запрос |
| Объект | obj |
Над чем выполняется действие | Над чем запрос |
| Действие | action |
Какое действие запрошено | Действие |
| Окружение | env |
Тариф, настройки аккаунта, возможности сервера | только Дополнительные условия |
Редактор собирает выражения в таком порядке и объединяет их логическим И:
-
Проверки субъекта (
subj.type,subj.rolesи т. п.). -
Проверка действия (
action.type), если выбрано не Любое. -
Проверки объекта (
obj.typeи атрибуты из конструктора). -
Каждая непустая строка поля Дополнительные условия.
Если все проверки истинны, правило считается применимым и возвращает выбранный эффект: Разрешить (permit) или Запретить (deny).
Для политики и группы политик тот же конструктор задаёт только назначение (target): применимость контейнера к запросу. Поля эффект у них нет — решение даёт алгоритм комбинирования по вложенным элементам.
N.B.
При сохранении правила простые выражения попадают в назначение (target), сложные — в дополнительные условия (condition). На результат проверки это не влияет: и те и другие должны быть истинны. Разница важна для политик и групп политик: в их назначении допускаются только простые выражения. Определение простого выражения — в разделе Синтаксис дополнительных условий.
Кто делает запрос (субъекты)
В списке редактора доступен один тип субъекта.
| Название в редакторе | subj.type |
Кто это |
|---|---|---|
| Сотрудник | agent |
Оператор, супервизор, администратор или сотрудник с иной ролью |
Пустое значение Ничего не выбрано означает «субъект любого типа»: правило не проверяет subj.type. В поставке все выражения, где субъект указан явно, используют только subj.type = 'agent'. Других значений в системных политиках нет. Служебный субъект system недопустим к использованию в политиках.
Атрибуты сотрудника
Атрибуты доступны и у субъекта (subj.*), и у объекта с типом agent (obj.*).
| Атрибут | Тип | Откуда в редакторе | Описание |
|---|---|---|---|
type |
строка | список Кто делает запрос / Над чем запрос | Всегда 'agent' |
id |
число | только условия | Идентификатор сотрудника. Сравнение со строковым литералом даёт ошибку вычисления выражения |
roles |
список строк | кнопка Добавить у субъекта или у объекта Сотрудник | Ключи ролей. Системные: admin, supervisor, operator. Пользовательские роли добавляются в меню ролей; в выражениях используется идентификатор роли, не отображаемое имя |
departments.all |
список сущностей department |
только условия | Все отделы сотрудника |
departments.subordinate |
список сущностей department |
только условия | Подревизные отделы (для супервизора) |
Примеры:
'supervisor' in subj.roles
intersects(subj.roles, ['admin', 'supervisor'])
obj in subj.departments.subordinate
subj = obj
Последнее выражение истинно, когда сотрудник действует сам над собой (например, редактирует свой профиль). Это сравнение двух сущностей — его нельзя собрать конструктором, только дописать в Дополнительные условия.
Кроме сотрудника сервер умеет представлять запрос от имени субъекта system — это служебные вызовы (фоновая почта статистики, внутренние API и т. п.), а не роль в интерфейсе. В списке редактора этого типа нет. Такие запросы не проходят через дерево политик: проверка доступа сразу возвращает разрешение. Писать в правиле subj.type = 'system' незачем: ни сотрудник, ни служебный вызов по этому условию не отфильтруются.
Действия
| Название в редакторе | action.type |
Когда появляется в списке | Типичное применение |
|---|---|---|---|
| Прочитать | read |
для всех объектов, кроме Функция системы | Просмотр сущности |
| Создать | create |
то же | Создание сущности |
| Обновить | update |
то же | Изменение сущности |
| Удалить | delete |
то же | Удаление сущности |
| Обращение | access |
только для Функция системы | Доступ к странице UI или группе API |
| Переключить в офлайн | disconnect |
только для Сотрудник | Принудительный перевод сотрудника в офлайн |
Значение Любое не добавляет проверку action.type: правило применимо к любому действию над выбранным объектом.
Можно выбрать несколько действий (значок множественного выбора). Тогда редактор запишет:
action.type in ['read', 'update']
Дополнительный атрибут действия
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
action.tags |
список строк | только условия | Метки запроса. В системных политиках встречается тег stats — чтение данных для статистики |
Пример: разрешить чтение диалога, но не для статистики:
action.type = 'read'
obj.type = 'chat'
'stats' not in action.tags
Над чем запрос (объекты)
Значение в списке Над чем запрос задаёт obj.type. Ничего не выбрано означает «любой объект». Можно выбрать несколько типов — тогда редактор запишет obj.type in [...].
Для части типов конструктор позволяет добавить атрибут (роль, ключ функции, секцию РМО и т. п.). Остальные атрибуты в списке не показываются: их используют только в Дополнительных условиях.
Краткая таблица
| Название в редакторе | obj.type |
Что это | Действия в списке | Атрибуты конструктора |
|---|---|---|---|---|
| Аккаунт | account |
Настройки аккаунта | CRUD | — |
| Блокировка | ban |
Запись чёрного списка посетителей | CRUD | — |
| Группа безопасности | security_group |
Группа безопасности SSO | CRUD | — |
| Группа политик | policy_set |
Элемент дерева политик | CRUD | — |
| Группа отчётов | report_group |
Папка в конструкторе аналитики | CRUD | — |
| Диалог | chat |
Диалог с посетителем | CRUD | — |
| Источник отчета | report_source |
Источник данных отчёта | CRUD | — |
| Кнопка | button |
Кнопка размещения | CRUD | — |
| Конфиг дашборда | dashboard_report_config |
Виджет панели приборов v2 | CRUD | — |
| Конфиг метрики | metric_config |
Пользовательская или системная метрика | CRUD | — |
| Конфиг опроса | survey_config |
Конфигурация опроса | CRUD | — |
| Конфиг отчета | report_config |
Настройки отчёта в конструкторе аналитики | CRUD | — |
| Оценка | rate |
Оценка диалога | CRUD | — |
| Отдел | department |
Отдел (скилл) | CRUD | — |
| Отдел сотрудника | agent_department |
Связь «сотрудник — отдел» | CRUD | agent.roles |
| Отчет | report |
Построенный отчёт | CRUD | — |
| Политика | policy |
Элемент дерева политик | CRUD | — |
| Правило | rule |
Элемент дерева политик | CRUD | — |
| Правило маршрутизации посетителей | visitor_routing_rule |
Правило маршрутизации | CRUD | — |
| Раздел РМО | visit_session_section |
Секция рабочего места оператора | CRUD | key |
| Размещение | location |
Размещение виджета | CRUD | key |
| Автоприглашение | invitation |
Правило генератора лидов | CRUD | — |
| Роли | role |
Роль сотрудника | CRUD | key |
| Сообщение | message |
Сообщение в диалоге | CRUD | kind |
| Сотрудник | agent |
Учётная запись сотрудника | CRUD + disconnect |
roles |
| Суфлер | prompter |
Суфлёр | CRUD | — |
| Функция системы | feature |
Страница UI или группа API | только access |
name |
| Cеанс | session |
Сеанс входа сотрудника | CRUD | — |
| Cеанс посетителя | visit_session |
Карточка посетителя в РМО | CRUD | section, section_for_assigned |
| Время сотрудника в статусе | agent_status_timer |
Таймер текущего статуса | CRUD | — |
Ниже — атрибуты, которые можно использовать в условиях, и типичные формулировки.
Функция системы (feature)
Доступ к странице интерфейса или к группе методов API. Это не конкретная запись (не «этот сотрудник», «этот отдел»), а разрешение «открыть раздел» / «вызывать API».
Чтобы сотрудник увидел список и смог с ним работать, обычно нужны оба разрешения: ui.* и соответствующий api.*. Примеры настройки — в статье Редактор политик.
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
type |
строка | список объектов | 'feature' |
name |
строка | атрибут Название | Ключ функции, например ui.chat, api.agents |
tariff_option |
строка или null |
только условия | Тарифная опция, от которой зависит функция. Для политик с системными ограничениями |
id |
строка | только условия | Совпадает с name |
Полный перечень ключей, которые предлагает список Название, — в приложении по функциям (features).
Примеры:
action.type = 'access'
obj.type = 'feature'
obj.name = 'ui.chat'
action.type = 'access'
obj.type = 'feature'
obj.name in ['ui.agents', 'api.agents']
obj.tariff_option != null
obj.tariff_option not in env.tariff.enabled_options
Сотрудник (agent)
Действия над учётной записью: чтение и изменение профиля, создание и удаление сотрудников, перевод в офлайн.
Атрибуты — те же, что у субъекта. Примеры общеупотребительных условий:
subj = obj
intersects(obj.departments.all, subj.departments.subordinate)
'admin' not in obj.roles
Отдел (department)
Отдел (скилл) в списке отделов и в привязках сотрудников.
| Атрибут | Тип | Описание |
|---|---|---|
type |
строка | 'department' |
id |
число | Идентификатор отдела |
Сравнить отдел с отделами субъекта:
obj in subj.departments.all
obj in subj.departments.subordinate
Отдел сотрудника (agent_department)
Связь конкретного сотрудника с конкретным отделом: состоит ли сотрудник в отделе, приоритет отдела, признак подревизности. Отдельно от объекта Отдел: правило на department не покрывает изменение привязки.
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
type |
строка | список объектов | 'agent_department' |
id |
строка | только условия | Составной идентификатор вида агент:отдел |
agent |
сущность agent |
только условия | Сотрудник в этой связи |
agent.roles |
список строк | атрибут Роли | Роли сотрудника в связи |
department |
сущность department |
только условия | Отдел в этой связи |
Примеры:
'admin' in obj.agent.roles
obj.department in subj.departments.subordinate
obj.agent = subj
Роли (role)
Сама роль как сущность (создание, удаление, изменение роли), а не «сотрудник с такой ролью». Права сотрудника по роли задаются проверкой subj.roles, а не объектом role.
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
type |
строка | список объектов | 'role' |
id |
строка (UUID) | только условия | Внутренний идентификатор. Сравнение с числовым литералом даёт ошибку вычисления выражения |
key |
строка | атрибут Идентификатор роли | Читаемый ключ: admin, supervisor, agent или ключ пользовательской роли |
Cеанс (session)
Сеанс входа сотрудника в систему (управление активными сеансами), не путать с Cеансом посетителя.
| Атрибут | Тип | Описание |
|---|---|---|
type |
строка | 'session' |
id |
идентификатор | Идентификатор сеанса |
agent |
сущность agent |
Сотрудник, которому принадлежит сеанс |
Пример — разрешить сотруднику управлять только своим сеансом:
obj.agent = subj
Время сотрудника в статусе (agent_status_timer)
Доступ к таймеру, сколько сотрудник находится в текущем статусе. У объекта в контексте проверки есть только type (и пустой id). Ограничение «таймер выключен в настройках» в системных политиках записывается через окружение:
not(env.config.operator_status_timer)
Группа безопасности (security_group)
Группа безопасности Active Directory (SSO). В контексте проверки доступны type и id.
Диалог (chat)
Диалог с посетителем: чтение истории, изменение, удаление.
| Атрибут | Тип | Описание |
|---|---|---|
type |
строка | 'chat' |
id |
идентификатор | Идентификатор диалога |
owner |
сущность agent или null |
Назначенный оператор |
agents |
список сущностей agent |
Участники диалога |
departments |
список сущностей department |
Отделы диалога |
Примеры:
subj = obj.owner
subj in obj.agents
intersects(obj.departments, subj.departments.all)
Cеанс посетителя (visit_session)
Карточка конкретного посетителя в РМО: можно ли увидеть этого посетителя в секции. Это не сама секция списка и не диалог как сущность chat.
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
type |
строка | список объектов | 'visit_session' |
id |
идентификатор | только условия | Идентификатор сеанса посетителя |
section |
строка | атрибут Cекция | Секция, в которой сеанс виден сейчас. Значения — ключи разделов РМО |
section_for_assigned |
строка | атрибут Секция у назначенного сотрудника | Секция с точки зрения назначенного оператора |
assigned_operator |
сущность agent или null |
только условия | Назначенный оператор |
department |
сущность department или null |
только условия | Отдел сеанса |
Пример из системных политик супервизора — запретить чужие диалоги в секции В диалоге с другими, если включена настройка скрытия чужих чатов:
action.type = 'read'
obj.type = 'visit_session'
subj != obj.assigned_operator
obj.section = 'in_chat_with_others'
obj.department not in subj.departments.subordinate
env.config.hide_anothers_chats
Раздел РМО (visit_session_section)
Сама секция рабочего места оператора (очередь, диалоги, последние и т. д.): можно ли читать или показывать раздел целиком. Чтобы сотрудник работал в РМО, обычно разрешают и ui.chat, и чтение нужных секций.
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
type |
строка | список объектов | 'visit_session_section' |
key |
строка | атрибут Название | Ключ секции |
Ключи разделов РМО
| Ключ | Название в интерфейсе |
|---|---|
queue |
Ожидают ответа |
invited |
Приглашенные |
in_chat |
В диалоге с Вами |
not_in_chat |
Остальные |
common_queue |
Общая очередь |
offline_queue |
Офлайн очередь |
on_hold |
На удержании |
closed_chats |
Последние диалоги |
closed_by_operator |
Закрытые диалоги |
in_chat_with_others |
В диалоге с другими |
Пример — разрешить минимальный набор секций для общения с посетителями:
action.type = 'read'
obj.type = 'visit_session_section'
obj.key in ['queue', 'in_chat', 'offline_queue', 'closed_chats', 'in_chat_with_others']
Сообщение (message)
Сообщение в диалоге: обычное сообщение оператора, файл, заметка, системное событие и т. д.
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
type |
строка | список объектов | 'message' |
kind |
строка | атрибут Тип сообщения | Вид сообщения |
chat |
сущность | только условия | Диалог, в котором создаётся сообщение. У вложенного диалога в проверках РМО доступен chat.agent — назначенный оператор |
Типы сообщений (obj.kind)
| Ключ | Название в редакторе |
|---|---|
operator |
От оператора |
visitor |
Посетитель |
info |
Информационное |
contacts |
Контакты |
cont_req |
Запрос контактов |
for_operator |
Для оператора |
file_operator |
Файл от оператора |
file_visitor |
Файл посетителя |
operator_busy |
Оператор занят |
operator_note |
Заметка оператора |
keyboard |
Кнопочное сообщение сотрудника |
keyboard_response |
Кнопочный ответ посетителя |
apple_chat |
Сообщение сотрудника в Apple-чатах |
apple_chat_response |
Сообщение посетителя в Apple-чатах |
Пример — разрешить заметки только в своих диалогах:
action.type = 'create'
obj.type = 'message'
obj.kind = 'operator_note'
obj.chat.agent = subj
Оценка (rate)
Оценка диалога.
| Атрибут | Тип | Описание |
|---|---|---|
type |
строка | 'rate' |
id |
идентификатор | Идентификатор оценки |
agent |
сущность agent |
Сотрудник, которому выставлена оценка |
Блокировка (ban)
Запись в чёрном списке посетителей. В контексте проверки доступны type и id.
Автоприглашение (invitation)
Правило генератора лидов (автоприглашений). В конструкторе дополнительных атрибутов нет; в проверках используются type и id.
Правило маршрутизации посетителей (visitor_routing_rule)
Правило маршрутизации входящих обращений. В контексте проверки доступны type и id.
Размещение (location)
Размещение кнопки чата.
| Атрибут | Тип | Откуда | Описание |
|---|---|---|---|
type |
строка | список объектов | 'location' |
id |
идентификатор | только условия | Идентификатор размещения |
key |
строка | атрибут Ключ размещения | Ключ размещения из списка размещений аккаунта |
Кнопка (button)
Кнопка конкретного размещения. В контексте проверки доступны type и id.
Аккаунт (account)
Настройки аккаунта (чтение и изменение общих параметров, не путать с ui.account_config — это доступ к странице редактора).
| Атрибут | Тип | Описание |
|---|---|---|
type |
строка | 'account' |
id |
строка | Имя аккаунта |
name |
строка | То же имя аккаунта |
Объекты конструктора аналитики
Эти типы соответствуют сущностям конструктора аналитики.
| Тип | Название в редакторе | Атрибуты в условиях |
|---|---|---|
report_source |
Источник отчета | type, id |
metric_config |
Конфиг метрики | type, id, owner (число), source |
report_config |
Конфиг отчета | type, id, owner (сущность владельца) |
report_group |
Группа отчётов | type, id, owner (число) |
dashboard_report_config |
Конфиг дашборда | type, id, owner (сущность владельца), roles, report_config_id |
report |
Отчет | в конструкторе — type = 'report'; при серверной проверке построенный отчёт может быть представлен как report_config |
У конфига метрики (metric_config) и группы отчётов (report_group) атрибут owner — числовой идентификатор сотрудника. Условие «только свои»:
obj.owner = subj.id
Сравнение этого числа с сущностью subj даёт ошибку типов, и правило отвечает решение не определено.
У конфига отчёта (report_config) и конфига дашборда (dashboard_report_config) owner — сущность владельца (сотрудник или системный субъект). Условие «только свои»:
obj.owner = subj
Для виджета панели приборов можно ограничить роли, которым виджет назначен:
intersects(obj.roles, subj.roles)
Конфиг опроса (survey_config)
Конфигурация опроса в конструкторе опросов.
| Атрибут | Тип | Описание |
|---|---|---|
type |
строка | 'survey_config' |
id |
идентификатор | Идентификатор конфигурации |
survey_launch_count |
число | Сколько раз опрос уже запускали |
Пример — запретить удаление опроса, который уже запускали:
action.type = 'delete'
obj.type = 'survey_config'
obj.survey_launch_count > 0
Суфлер (prompter)
Суфлёр. В контексте проверки доступны type и id.
Элементы дерева политик (rule, policy, policy_set)
Сами правило, политика и группа политик как объекты доступа: кто может читать и менять дерево в Редакторе политик. В контексте проверки у каждого типа есть type и id. Доступ к странице редактора — это отдельная функция ui.policy_management / api.policy_management.
Объекты, которых нет в списке редактора
Их нельзя выбрать в Над чем запрос конструктора, но можно применять в политиках. Тип можно написать вручную в Дополнительных условиях (obj.type = 'channel').
obj.type |
Назначение | Атрибуты |
|---|---|---|
channel |
Канал коммуникации (мессенджер, почта и т. п.) | channel_type, tariff_option, required_capability |
invoice |
Счёт | type, id |
organization |
Организация (проверка по типу) | как правило только type |
policy_management_state |
Состояние дерева политик (включено / выключено) | type |
Пример системного ограничения на канал:
obj.type = 'channel'
obj.required_capability != null
obj.required_capability not in env.capabilities.available
Дополнительные условия
Поле Дополнительные условия — многострочный ввод. Подсказок, автодополнения и списка сущностей в интерфейсе нет: строка должна быть корректным выражением языка политик.
Когда поле обязательно
Конструктор покрывает только простые проверки. В поле нужно писать, если требуется:
-
сравнить две сущности:
subj = obj,subj = obj.owner,obj in subj.departments.all; -
обратиться к окружению:
env.tariff.*,env.config.*,env.capabilities.*; -
вызвать функцию:
not(...),length(...),intersects(...); -
использовать атрибут, которого нет в конструкторе выбранного типа (
obj.owner,obj.assigned_operator,obj.tariff_option,action.tagsи т. п.); -
взять булев признак как целое выражение:
env.config.hide_common_queue.
Синтаксис дополнительных условий
-
Одна строка — одно выражение.
-
Пустые строки игнорируются.
-
Все строки объединяются через логическое И: правило применимо, только если истинна каждая строка.
-
Строки — в одинарных или двойных кавычках:
'ui.chat',"admin". -
Списки — в квадратных скобках:
['read', 'update']. -
Имена атрибутов, как и имена функций, чувствительны к регистру и пишутся точно как в справочнике, допустимы латинские буквы и
_, после первого символа в имени допустимы и цифры. Используйте нижний регистр. Например,Subj.Rolesдаст ошибку пути. Ключевые слова — регистронезависимы, допустима только латиница (notОК;недаст ошибку). -
Обращение к атрибуту — через точку:
subj.roles,env.tariff.enabled_options,obj.departments.all.
Полная грамматика, типы и ошибки сравнения — в статье Выражения. Ниже — то, чего достаточно, чтобы собрать условие в редакторе.
Операторы
| Запись | Смысл | Операнды |
|---|---|---|
= / != |
равно / не равно | числа, строки, логические, null, две конкретные сущности одного типа |
>, >=, <, <= |
сравнение порядка | только числа |
in / not in |
входит / не входит в список | слева — атомарное значение или сущность, справа — список |
Нельзя сравнивать два списка оператором = ([1, 2] = [1, 2] даёт ошибку типа). Для пересечения списков используйте intersects.
Функции
| Функция | Сигнатура | Смысл |
|---|---|---|
not(x) |
boolean → boolean |
Отрицание |
length(list) |
list → integer |
Число элементов |
intersects(a, b) |
(list, list) → boolean |
Есть хотя бы один общий элемент |
Вызов функции сам по себе может быть выражением, только если возвращает boolean (not(...), intersects(...)). length(...) нужно сравнивать с числом: length(subj.departments.all) > 0.
Простые и сложные выражения
Простое выражение — сравнение атрибута с константой или списком констант, без функций и без сравнения двух атрибутов.
Простые (можно оставить в назначении политики и в конструкторе):
subj.type = 'agent'
action.type = 'read'
obj.type = 'feature'
obj.name = 'ui.chat'
obj.key in ['queue', 'in_chat']
'supervisor' in subj.roles
Сложные (только в Дополнительных условиях правила):
subj = obj
obj in subj.departments.subordinate
obj.tariff_option not in env.tariff.enabled_options
intersects(subj.roles, ['admin', 'supervisor'])
not(env.config.operator_status_timer)
env.config.hide_common_queue
У политики и группы политик сложное выражение в назначении редактор и сервер отклонят. Вынесите его в правило.
Некорректные формулировки, которые редактор не примет:
obj.key in 'queue'
action.type = ['read', 'update']
Правильно: obj.key = 'queue' или obj.key in ['queue']; action.type in ['read', 'update'].
Окружение (env)
Окружение не выбирается в списке объектов. Все обращения к нему пишутся в Дополнительных условиях.
Тариф
| Атрибут | Тип | Описание |
|---|---|---|
env.tariff.enabled_options |
список строк | Ключи включённых тарифных опций |
env.account.tariff |
строка | Идентификатор тарифа аккаунта (при серверной проверке) |
Проверка «опция включена в тарифе»:
'has_supervisors' in env.tariff.enabled_options
'departments' not in env.tariff.enabled_options
Ключи, которые система подставляет в enabled_options при вычислении (значение попадает в список, только если опция реально включена):
| Ключ | Связанная возможность |
|---|---|
ban |
Блокировки |
bots |
Боты |
broadcasts |
Рассылки |
categories |
Категории |
chat |
Чат |
dashboard |
Панель приборов |
departments |
Отделы |
has_supervisors |
Роль супервизора |
invitation |
Автоприглашения |
locations |
Размещения |
online_periods |
Активность сотрудников |
operators_list |
Список сотрудников |
outgoing_voice_messages |
Исходящие голосовые сообщения |
policy_management |
Управление политиками |
prompters |
Суфлёры |
report_configs |
Конструктор аналитики |
scenario_bot |
Сценарные боты |
section_table_view |
Табличный вид секций |
sso |
Единый вход |
stats |
Статистика |
surveys |
Опросы |
visitor_enabling_probability |
Вероятность показа виджета |
visitor_queue_limit |
Лимит очереди |
visitor_routing_rules |
Маршрутизация посетителей |
workhours |
График работы |
whatsapp_templates |
Шаблоны WhatsApp1 |
line_broadcasts |
Рассылки LINE |
high_priority_urls |
Приоритетные URL |
apple_chat_integration |
Apple Messages for Business |
avito_integration |
Авито |
creatio_crm_integration |
Creatio CRM |
custom_channel_integration |
Кастомный канал |
email_integration |
|
email_imap_integration |
Email через IMAP |
line_integration |
LINE |
max_integration |
MAX |
odnoklassniki_integration |
Одноклассники |
seventech_integration |
SevenTech |
telegram_integration |
Telegram |
viber_integration |
Viber |
vk_integration |
VK |
whatsapp_360dialog_integration |
WhatsApp через 360dialog1 |
whatsapp_gupshup_integration |
WhatsApp через GupShup1 |
Настройки аккаунта (env.config)
Значения соответствуют опциям настроек аккаунта и связанным признакам. Булево значение можно использовать как целое выражение (env.config.hide_common_queue означает «настройка включена»).
| Атрибут | Тип | Где учитывается | Описание |
|---|---|---|---|
env.config.operator_department_prioritization |
boolean | везде | Приоритизация отделов (скиллизация) |
env.config.operator_status_timer |
boolean | везде | Таймер статуса сотрудника |
env.config.restricted_options |
список строк | везде | Тарифные опции, запрещённые текущим ролям субъекта (карта restricted_options из настроек) |
env.config.restricted_profiles |
boolean | UI и admin API | Ограничение редактирования своего профиля |
env.config.multilang |
boolean | UI и admin API | Мультиязычность |
env.config.sso_enabled |
boolean | везде | SSO включён |
env.config.analytics_v2_dashboard |
boolean | UI и admin API | Панель приборов v2 в настройках |
env.config.analytics_v2_stats |
boolean | UI и admin API | Статистика v2 в настройках |
env.config.analytics_v2_builder |
boolean | UI и admin API | Конструктор аналитики в настройках |
env.config.server_dicts_spell_check |
boolean | UI и admin API | Серверная проверка орфографии |
env.config.show_chatting_timer_in_settings |
boolean | UI и admin API | Таймер диалога в настройках |
env.config.show_channel_ids_in_settings |
boolean | UI | Показ идентификаторов каналов |
env.config.service_support_widget |
boolean | UI | Виджет чата службы поддержки |
env.config.hide_anothers_chats_in_history |
boolean | admin API | Скрывать чужие диалоги в истории |
env.config.hide_chats_from_other_departments_in_history |
boolean | admin API | Скрывать в истории диалоги других отделов |
env.config.hide_common_queue |
boolean | РМО | Скрывать общую и офлайн-очереди |
env.config.hide_anothers_chats |
boolean | РМО | Скрывать чужие диалоги |
env.config.hide_others |
boolean | РМО | Скрывать секцию Остальные |
env.config.operator_note_messages |
boolean | РМО | Разрешены заметки оператора |
Для правил видимости очередей и карточек в РМО используйте hide_common_queue, hide_anothers_chats и hide_others. Для ограничений истории в панели управления — пары hide_*_in_history.
Примеры:
obj.tariff_option in env.config.restricted_options
not(env.config.operator_status_timer)
env.config.hide_common_queue
Возможности сервера
| Атрибут | Тип | Описание |
|---|---|---|
env.capabilities.available |
список строк | Возможности (capabilities), доступные на этом сервере |
Используется в системных ограничениях каналов: obj.required_capability not in env.capabilities.available.
Сравнение сущностей
Сущность в выражениях — значение с типом и идентификатором, например сотрудник (type=agent, id=12) или отдел (type=department, id=3).
-
subj = objистинно, если совпадают и тип, и идентификатор. -
Сравнивать конкретную сущность с «типом без id» нельзя — это ошибка типов.
-
Сущность можно проверять на вхождение в список сущностей:
obj in subj.departments.all. -
Число не равно сущности:
1 in subj.departments.allдастfalse.
Вложенные сущности разворачиваются через точку: obj.agent у связи с отделом, obj.owner у диалога, obj.assigned_operator у сеанса посетителя, obj.chat.agent у сообщения.
Готовые формулировки
Разрешить редактировать только свой профиль:
action.type in ['read', 'update']
obj.type = 'agent'
subj = obj
Разрешить супервизору читать отделы, которыми он руководит:
action.type = 'read'
obj.type = 'department'
obj in subj.departments.subordinate
Применять группу политик только к пользовательской роли с идентификатором customrole (это простое выражение, его можно поставить в назначение группы):
subj.type = 'agent'
'customrole' in subj.roles
Запретить функцию, если тарифная опция выключена или запрещена ролью:
action.type = 'access'
obj.type = 'feature'
obj.tariff_option != null
obj.tariff_option not in env.tariff.enabled_options
action.type = 'access'
obj.type = 'feature'
obj.tariff_option != null
obj.tariff_option in env.config.restricted_options
Алгоритмы комбинирования
Алгоритм задаётся у политики и у группы политик (поле Алгоритм комбинирования). Он решает, как из ответов вложенных элементов получить один ответ. Вложенные элементы просматриваются сверху вниз — в том порядке, в каком они стоят в дереве.
Новая политика и новая группа по умолчанию получают алгоритм Запретить, если не разрешено.
| Название в редакторе | Идентификатор | Как выбирается решение |
|---|---|---|
| Запрет переопределяет | deny_overrides |
Если хотя бы один применимый элемент вернул Запретить, итог — Запретить. Иначе, если есть Разрешить, итог — Разрешить. Ошибка вычисления важнее разрешения. Если никто не применился — Не применимо |
| Разрешение переопределяет | permit_overrides |
Симметрично предыдущему: достаточно одного Разрешить. Запрет учитывается, только если разрешений нет |
| Запретить, если не разрешено | deny_unless_permit |
Итог Разрешить, только если нашлось хотя бы одно разрешение. Во всех остальных случаях, в том числе когда никто не применился, итог — Запретить. «Закрыто по умолчанию» |
| Разрешить, если не запрещено | permit_unless_deny |
Итог Запретить, только если нашёлся хотя бы один запрет. Иначе — Разрешить. «Открыто по умолчанию» |
| Первый применимый элемент | first_applicable |
Берётся решение первого сверху элемента, который применим к запросу (не Не применимо). Остальные не смотрятся. Порядок в дереве критичен |
| Только один применимый элемент | only_one_applicable |
Если применим ровно один элемент — берётся его решение. Если применимых нет — Не применимо. Если применимы двое или больше — ошибка (решение не определено) |
Практические следствия:
-
Группа Разрешения сотрудников по ролям в системном дереве использует Первый применимый элемент. Сверху стоит администратор, затем супервизор, затем оператор. Группа оператора подходит любому сотруднику, поэтому пользовательскую роль нужно ставить выше группы Оператор. Иначе её правила не будут учитываться. Подробнее — в Редакторе политик.
-
Корневая группа системного дерева использует Запретить, если не разрешено: нет явного разрешения — доступ закрыт.
-
Для набора запретов (тариф, capabilities) удобен Запрет переопределяет: один запрещающий элемент перекрывает разрешения ниже по дереву.
Формальные определения совпадают с приложением C стандарта XACML 3.0; в Webim все алгоритмы считаются упорядоченными (Ordered).
Приложение. Функции системы
Значения атрибута obj.name для obj.type = 'feature'. Так они подписаны в списке Название, когда объект — Функция системы.
Ключи ui.* открывают страницу или блок интерфейса. Ключи api.* разрешают группу запросов к серверу. Для работы раздела обычно нужны оба.
Интерфейс (ui.*)
| Название в редакторе | obj.name |
|---|---|
| Общие настройки | ui.account_config |
| История действий | ui.action_log |
| Сотрудники | ui.agents |
| Блокировки | ui.bans |
| Боты | ui.bots |
| Рассылки | ui.broadcasts |
| Рассылки | ui.broadcasts_management |
| Категории | ui.categories |
| Каналы общения | ui.channels |
| Рабочее место оператора | ui.chat |
| Закрытие диалогов | ui.close_chats |
| Панель приборов (Deprecated) | ui.dashboard |
| Панель приборов v2 | ui.dashboard_v2 |
| Панель приборов v2 (old part) | ui.dashboard_v2_old_part |
| Отделы | ui.departments |
| История | ui.history |
| Интеграции | ui.integrations |
| Автоприглашения | ui.invitations |
| База знаний | ui.knowledge_base |
| Активация лицензии | ui.license_form |
| Рассылки LINE | ui.line_broadcasts |
| Кнопки и размещения | ui.locations |
| Финансы | ui.payments |
| Безналичный расчет | ui.cashless_payment |
| Метод оплаты InvoiceBox | ui.invoicebox_payment |
| Политики | ui.policy_management |
| Профиль | ui.profile |
| Суфлеры | ui.prompters |
| Конструктор аналитики | ui.report_configs_management |
| Роли | ui.roles |
| Сценарные боты | ui.scenario_bots |
| Группы безопасности | ui.security_groups |
| Чат службы поддержки | ui.service_support_widget |
| Управление сеансами | ui.session_management |
| Орфографический словарь | ui.spelling_dictionary |
| Настройки единого входа | ui.sso_settings |
| Статистика (Deprecated) | ui.statistics |
| Статистика v2 | ui.statistics_v2 |
| Активность сотрудников | ui.status_periods |
| Опросы | ui.survey_configs |
| Маршрутизация посетителей | ui.visitor_routing_rules |
| Шаблоны WhatsApp1 | ui.whatsapp_templates |
| График работы | ui.work_hours |
| Интеграция с Apple Messages for Business | ui.apple_chat_integration |
| Интеграция с Авито | ui.avito_integration |
| Интеграция с Creatio CRM | ui.creatio_crm_integration |
| Интеграция с кастомным каналом | ui.custom_channel_integration |
| Интеграция с email | ui.email_integration |
| Интеграция с email через IMAP | ui.email_imap_integration |
| Интеграция с LINE | ui.line_integration |
| Интеграция с MAX | ui.max_integration |
| Интеграция с Одноклассники | ui.odnoklassniki_integration |
| Интеграция с SevenTech | ui.seventech_integration |
| Интеграция с Telegram | ui.telegram_integration |
| Интеграция с Viber | ui.viber_integration |
| Интеграция с VK | ui.vk_integration |
| Интеграция с WhatsApp через 360dialog1 | ui.whatsapp_360dialog_integration |
| Интеграция с WhatsApp через GupShup1 | ui.whatsapp_gupshup_integration |
API (api.*)
| Название в редакторе | obj.name |
|---|---|
| Аккаунт (API) | api.account |
| История действий (API) | api.action_log |
| Сотрудники (API) | api.agents |
| Блокировки (API) | api.bans |
| Рассылки (API) | api.broadcasts |
| Каналы (API) | api.channels |
| Диалоги (API) | api.chats |
| Закрытие диалогов (API) | api.close_chats |
| Панель приборов (API) | api.dashboard |
| Настройки панели приборов (API) | api.dashboard_report_config |
| Отделы (API) | api.departments |
| Интеграции (API) | api.integrations |
| Автоприглашения (API) | api.invitations |
| IOS сертификаты (API) | api.ios_push_certificates |
| Размещения (API) | api.locations |
| Финансы (API) | api.payments |
| Управление политиками (API) | api.policy_management |
| Приватные ключи (API) | api.private_keys |
| Суфлеры (API) | api.prompters |
| Отчёты (API) | api.report |
| Настройки отчетов (API) | api.report_config |
| Настройки групп отчетов (API) | api.report_group |
| Метрики (API) | api.report_metric |
| Настройки опций отчетов (API) | api.report_settings |
| Источник отчета (API) | api.report_source |
| Боты (API) | api.robots |
| Роли (API) | api.roles |
| Группы безопасности (API) | api.security_groups |
| Управление сеансами (API) | api.session_management |
| Словари (API) | api.spelling_dictionary |
| Активность сотрудников (API) | api.status_periods |
| Конструктор опросов (API) | api.survey_configs |
| Unisender (API) | api.unisender |
| Маршрутизация посетителей (API) | api.visitor_routing_rules |
| Посетители (API) | api.visitors |