帮助中心集成

为了: 管理员

读取具有管理密钥的角色

列出您中心的角色并读取其中一个角色的权限,以便您的软件可以将具有正确角色的人员分配到案例中。

在本文中5 个部分

开始之前

此页面介绍了如何读取您所在平台中的角色角色 一组权限,用于决定某人(例如员工或客户)可以查看和处理案件的哪些内容。信息。当您将某人分配到某个案例时,需要发送这些角色的ID。路径位于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

某个角色的ID为role::,其名称则如role::senior-paralegal所示。每个中心角色都拥有三个内置角色:

角色 ID适用人群
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该角色可以上传的最大文件大小,以MB为单位,按类型分类如下:audios、docs、files、images、schemas和videos

该列表中有些角色并未被包含在内,因此答案中并没有提到他们。

默认情况下,role::staff和role::bots可以管理案例中的所有内容。而role::clients则可以查看案例及其各个部分的信息,但无法访问笔记、帖子及评论等部分。x2/有权自行添加事件、表单、电子签名以及任务,并支付发票款项。不过,您的系统设置可能已进行了更改。关于每个权限的具体功能,请参考了解所有角色的权限设置部分。

如果电话被拒绝

地位message为什么
404ItemNotFoundException你的中心节点与那个标识符没有任何关联。
403BotNotAllowedException您尝试创建、修改或删除某个角色。

相关文章

使用管理密钥添加和删除案例成员为案件分配人员角色和职称,发送邀请邮件,查看案件中的人员,或将某人从案件中移除。集成查找每个角色权限按案例页面部分列出全部 43 个权限,每个权限允许什么,以及员工和客户角色默认拥有什么。安全与账户创建自定义角色添加高级律师助理或共同律师等角色,从预设开始,然后选择其权限和文件限制。安全与账户 · 10 min