Центр поддержкиИнтеграции

Для: Администраторы

Чтение ролей с помощью управляющего ключа

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

В этой статье5 разделов

Прежде чем начать

На этой странице рассказывается о том, как читать информацию из вашего хаба. РолиРоль Набор разрешений, определяющий, что может видеть и делать тот или иной пользователь в рамках дела, например, сотрудники или клиенты., Идентификаторы людей, которых вы отправляете при присоединении к какому-либо делу. Пути передачи данных находятся в разделе… https://prd-api-manage.caseactive.com/v1/<hub id>. Ключ может определять роли, но не может создавать, изменять или удалять эти роли.

Звонки

ВызовЧто это делает
GET /rolesСписок ролей вашего хаба
GET /roles/<role_id>Читает один роль, а также все принадлежащие ему разрешения.

GET /roles принимает значения limit (по умолчанию – 20) и start_key. Также startKey используется из предыдущей страницы. У хаба может быть не более 20 ролей. Поэтому одно вызова с использованием значения limit=20 позволяет выполнить все необходимые действия.

Идентификаторы ролей

ID роли – role::; название роли – role::senior-paralegal. У каждого хаба имеются три встроенные роли.

Идентификатор ролиДля кого это предназначено?
role::clientsКлиенты
role::staffВаша команда
role::botsВаш хаб… Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника., Это то, что выполняет каждая API-ключ. Не давайте её никому.

Что включает в себя эта роль

GET /roles отвечает за role_id, name, role_type (для трех встроенных ролей – system; для своей роли – custom), а также за description, color и users_ct. Это указывает количество мест, которые может занимать эта роль в различных случаях.

{
  "data": {
    "items": [
      {"role_id": "role::clients", "name": "clients", "role_type": "system", "color": "#10B981", "users_ct": 214},
      {"role_id": "role::senior-paralegal", "name": "senior-paralegal", "role_type": "custom", "description": "Paralegals who run intake", "color": "#6366F1", "users_ct": 9}
    ],
    "currentItemCount": 2,
    "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles"
  }
}

GET /roles/<role_id> добавляет:

ПолеЧто в нём содержится
permissionsКакую роль может играть каждый из этих элементов в определенном случае: case, convos, events, posts, forms, signs, invoices, notes, tasks и team. В каждом разделе указаны имена таких элементов, как list_posts (см. их), put_post (добавьте или измените свои собственные данные), delete_post, put_comment и moderator (управление данными всех пользователей).
case_read_fields, case_write_fieldsВ документе описывается роль, которую играет данное лицо, а также те аспекты, которые могут измениться в будущем.
user_read_fields, user_write_fieldsДетали профиля других участников этого дела могут меняться в зависимости от их ролей.
file_sizeМаксимальный размер файла, который роль может загрузить, в мегабайтах, по типам: audios, docs, files, images, schemas и videos

Список ролей не содержит ничего, что не должно быть включено в ответ.

По умолчанию: role::staff и role::bots Можно управлять всеми деталями одной ситуации. role::clients Можно видеть все разделы страницы, но также можно добавлять свои собственные записи, сообщения и комментарии. Также можно использовать различные формы, электронные документы и задания. Кроме того, можно выставлять счета. Возможно, что ваша версия сайта изменила эти функции. Что именно позволяет каждое право, смотрите здесь. Узнайте о правилах использования каждой роли..

Если звонок отклонен

СтатусmessageПочему
404ItemNotFoundExceptionУ вашего хаба нет никакой роли в этом вопросе.
403BotNotAllowedExceptionВы попытались создать, изменить или удалить какую-либо роль.

Статьи по теме

Добавляйте и удаляйте участников дела с помощью управляющего ключа.Распределяйте людей по делам, указывая их роли и должности, отправляйте приглашения по электронной почте, читайте список участников дела или снимайте кого-либо с участия.ИнтеграцииПроверьте все разрешения ролей.Список всех 43 разрешений по разделам страницы дела, что каждое из них позволяет, и что по умолчанию получают роли сотрудников и клиентов.Безопасность и учетные записиСоздайте пользовательскую рольДобавьте роль, например, старшего помощника юриста или со-юриста, начните с предустановленных настроек, затем выберите для нее права доступа и ограничения на количество файлов.Безопасность и учетные записи · 10 min