Para: Administradores
Lea los roles con una clave de gestión
Enumera los roles de tu centro y lee los permisos de cada rol, para que tu software pueda asignar a las personas el rol correcto a los casos.
En este artículo5 secciones
Antes de empezar
Esta página le permite leer los rolesPapel Un conjunto de permisos que determina qué puede ver y hacer una persona en un caso, como por ejemplo, el personal o los clientes. de su hub. Los IDs de estos roles se envían cuando se asigna a alguien un caso. Los caminos están indicados en https://prd-api-manage.caseactive.com/v1/<hub id>. Una clave puede leer los roles, pero no puede crearlos, modificarlos ni eliminarlos.
Llamadas
| Llamar | Lo que hace |
|---|---|
GET /roles | Lista de las funciones de su centro de datos. |
GET /roles/<role_id> | Lee una función, junto con las permisos asociados a ella. |
GET /roles toma como parámetros limit (por defecto: 20) y start_key. Además, también toma el valor de startKey del paso anterior. Un hub puede tener hasta 20 roles. Por lo tanto, una llamada con limit=20 permite que todos los roles sean utilizados.
Identificadores de roles
La ID de una función es role::, y su nombre es role::senior-paralegal. Cada nodo tiene tres funciones incorporadas.
| ID de rol | Para quién es |
|---|---|
role::clients | Clientes |
role::staff | Su equipo |
role::bots | Tu centro de control… Asistente virtualAsistente virtual Un miembro del equipo automatizado que publica mensajes de bienvenida, registros de asistencia y actualizaciones de la empresa; sus publicaciones llevan una insignia de Asistente Virtual., Cualquier clave de API puede funcionar como tal. No la dé a nadie. |
Qué implica un rol
GET /roles responde a los valores de role_id, name, role_type (system para los tres roles integrados; custom para el propio rol). También responde a los valores de description, color y users_ct. Es decir, indica la cantidad de posiciones que ocupa en cada caso.
{
"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> añade:
| Campo | Lo que contiene |
|---|---|
permissions | El rol que puede desempeñar en cada caso es el siguiente: case, convos, events, posts, forms, signs, invoices, notes, tasks y team. Cada sección enumera nombres como list_posts (vea los mismos), put_post (agregue o edite los propios), delete_post, put_comment y moderator (para gestionar los datos de todos). |
case_read_fields, case_write_fields | El caso describe en detalle el papel que desempeña, así como las posibles cambios que podría experimentar. |
user_read_fields, user_write_fields | Los detalles del perfil de las demás personas involucradas en el caso pueden cambiar según el papel que les corresponde desempeñar. |
file_size | El archivo más grande que el rol puede subir, en MB, según su tipo: audios, docs, files, images, schemas y videos |
Se ha omitido una posición del rol en la lista; esa posición no tiene ningún significado en el contexto de la respuesta.
Por defecto, role::staff y role::bots pueden gestionar todo lo relacionado con un caso en particular. role::clients puede ver el caso y todas las secciones relacionadas con él, excepto las notas, los comentarios, los formularios, los documentos electrónicos y las tareas. También puede agregar sus propios eventos, formularios y tareas. Es posible que su centro de control haya cambiado estas configuraciones. Para conocer qué permisos cada rol tiene, vea Consulte los permisos de cada rol.
Si se rechaza una llamada
| Estado | message | Por qué |
|---|---|---|
| 404 | ItemNotFoundException | Su centro de control no tiene ningún papel en ese ID. |
| 403 | BotNotAllowedException | Intentaste crear, modificar o eliminar alguna función/rol. |