Pour: Administrateurs
Lire les rôles avec une clé de gestion
Répertoriez les rôles de votre hub et consultez les autorisations d'un rôle afin que votre logiciel puisse affecter les personnes ayant le rôle approprié aux dossiers.
Dans cet article5 sections
Avant de commencer
Cette page vous indique comment lire les rôlesRôle Un ensemble d'autorisations qui détermine ce qu'une personne peut voir et faire sur un dossier, qu'il s'agisse de membres du personnel ou de clients. de votre hub. Les identifiants de ces rôles sont envoyés lorsque vous nommez quelqu’un au sein d’une affaire. Les chemins de répertoire se trouvent sous https://prd-api-manage.caseactive.com/v1/<hub id>. Une clé peut lire les rôles, mais elle ne peut pas les créer, les modifier ou les supprimer.
Appels
| Appel | Ce que cela fait |
|---|---|
GET /roles | Liste des rôles de votre hub. |
GET /roles/<role_id> | Lise une fonction, avec toutes les permissions qui y sont associées. |
GET /roles prend limit (valeur par défaut : 20), ainsi que start_key et startKey provenant de la page précédente. Un hub peut avoir au maximum 20 rôles. Ainsi, une seule appelation avec limit=20 suffit pour activer tous les rôles.
ID de rôle
L’ID d’un rôle est role::, et son nom est role::senior-paralegal. Chaque hub dispose de trois rôles intégrés.
| ID de rôle | À qui est-ce destiné ? |
|---|---|
role::clients | Clients |
role::staff | Votre équipe |
role::bots | Votre assistant virtuelAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel.… Toute clé API fonctionne en tant qu’assistant virtuel. Ne la donnez à personne. |
Quel rôle réserve-t-il ?
GET /roles répond à chaque rôle correspondant aux valeurs role_id, name, role_type (system pour les trois rôles intégrés, custom pour le vôtre). De plus, x0 répond également à description, color et users_ct, c’est-à-dire au nombre de positions qu’il occupe dans les cas.
{
"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> ajoute :
| Champ | Ce qu'il contient |
|---|---|
permissions | Le rôle que cette fonction peut jouer dans un cas donné est le suivant : case, convos, events, posts, forms, signs, invoices, notes, tasks et team. Chaque section liste des noms tels que list_posts (voir ceux-ci), put_post (ajouter ou modifier les propres noms), delete_post, put_comment et moderator (gérer les noms de tous). |
case_read_fields, case_write_fields | Le cas décrit le rôle que joue cette entité, ainsi que les changements qui pourraient survenir. |
user_read_fields, user_write_fields | Les détails concernant les autres personnes impliquées dans cette affaire peuvent changer en fonction du rôle qu’elles jouent. |
file_size | Le fichier le plus volumineux que le rôle peut télécharger, en MB, selon le type : audios, docs, files, images, schemas et videos |
La liste des rôles qui existent ne fait pas partie de la réponse.
Par défaut, role::staff et role::bots peuvent gérer tout ce qui concerne une case donnée. role::clients peut voir la case et toutes les sections concernées, à l’exception des notes, des posts et des commentaires. Il peut également ajouter ses propres événements, formulaires, signatures électroniques et tâches. Votre hub peut avoir modifié ces permissions. Pour savoir ce que chaque permission permet, veuillez consulter Veuillez consulter les permissions de chaque rôle.
Si un appel est refusé
| Statut | message | Pourquoi |
|---|---|---|
| 404 | ItemNotFoundException | Votre partenaire n’a aucun rôle dans cette affaire. |
| 403 | BotNotAllowedException | Vous avez essayé de créer, modifier ou supprimer un rôle. |