HilfezentrumIntegrationen

Für: Administratoren

Lesen Sie Rollen mit einem Verwaltungsschlüssel

Listen Sie die Rollen Ihres Hubs auf und lesen Sie die Berechtigungen einer Rolle, damit Ihre Software die richtigen Personen den Fällen mit der passenden Rolle zuweisen kann.

In diesem Artikel5 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt die Funktionen der RollenRolle Ein Satz von Berechtigungen, der festlegt, was jemand in einem Fall sehen und tun kann, z. B. Mitarbeiter oder Klienten. in Ihrem Hub. Die IDs dieser Rollen werden bei der Zuweisung einer Person zu einem Fall übermittelt. Die Pfade befinden sich unter https://prd-api-manage.caseactive.com/v1/<hub id>. Ein Benutzer kann die Rollen lesen, aber sie nicht erstellen, ändern oder löschen.

Anrufe

AnrufWas es tut
GET /rolesListe der Rollen Ihres Zentrums
GET /roles/<role_id>Liest eine Rolle zusammen mit den damit verbundenen Berechtigungen.

GET /roles nimmt limit (Standardwert: 20) sowie start_key entgegen – außerdem die startKey aus der vorherigen Seite. Ein Hub kann maximal 20 Rollen haben. Daher reicht eine Anfrage mit limit=20 aus, um alle Rollen zu erhalten.

Rollen-IDs

Die ID einer Rolle ist role::, und ihr Name ist role::senior-paralegal. Jeder Hub verfügt über drei integrierte Rollen.

Rollen-IDFür wen es gedacht ist
role::clientsKunden
role::staffEuer Team
role::botsEuer Partner/Partnerin Virtuelle Assistentin/Virtueller AssistentVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen., Jeder API-Schlüssel fungiert dabei als solcher Schlüssel. Geben Sie ihn niemandem weiter.

Welche Rolle beinhaltet

GET /roles antwortet auf die role_id-, name-, role_type-Funktionen jeweils – für die drei eingebauten Rollen sind das system, für die eigene Rolle ist es custom. Zudem gibt es noch die Funktionen description, color und users_ct. Die Anzahl der Positionen, die diese Funktionen besitzen, wird ebenfalls angegeben.

{
  "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> fügt hinzu:

FeldWas es enthält
permissionsWas die Rolle in einem bestimmten Fall bewirken kann, ist wie folgt: case, convos, events, posts, forms, signs, invoices, notes, tasks und team. Jede dieser Bereiche enthält Bezeichnungen wie list_posts (sehen Sie sie), put_post (fügen Sie diese hinzu oder bearbeiten Sie sie selbst), delete_post, put_comment und moderator (verwalten Sie alle diese Bereiche).
case_read_fields, case_write_fieldsDer Fall beschreibt die Rolle, die diese Person spielt – sowie die Möglichkeiten, wie sich diese Rolle ändern könnte.
user_read_fields, user_write_fieldsDie Details bezüglich der Rolle, die andere Personen in diesem Fall spielen, können sich ändern.
file_sizeDie größte Datei, die die Rolle überhaupt hochladen kann – in MB angegeben – ist jeweils für die Kategorien: audios, docs, files, images, schemas und videos.

Die Liste enthält keine Informationen über die Rolle desjenigen, der nicht in der Antwort aufgeführt wird.

Standardmäßig: role::staff Und… role::bots Man kann alles in einem Fall verwalten. role::clients Man kann alle Bereiche des Systems sehen – außerdem können Notizen, Beiträge und Kommentare hinzugefügt werden. Zudem können eigene Ereignisse, Formulare, elektronische Signatur sowie Aufgaben erstellt werden. Auch die Rechnungen können bearbeitet werden. Ihr Dashboard könnte diese Einstellungen bereits geändert haben. Was jede Berechtigung ermöglicht, finden Sie hier. Prüfen Sie alle Berechtigungen für jede Rolle..

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
404ItemNotFoundExceptionIhr Hub hat keine Rolle bei dieser ID.
403BotNotAllowedExceptionSie haben versucht, eine Rolle zu erstellen, zu ändern oder zu löschen.

Verwandte Artikel

Fallmitglieder mit einem Verwaltungsschlüssel hinzufügen und entfernenWeisen Sie Personen Fälle mit einer Rolle und Bezeichnung zu, versenden Sie die Einladungs-E-Mail, lesen Sie nach, wer an einem Fall arbeitet, oder entfernen Sie jemanden.IntegrationenÜberprüfen Sie alle Rollenberechtigungen.Eine Liste aller 43 Berechtigungen nach Fallseitenabschnitt, was jede Berechtigung erlaubt und welche Berechtigungen den Mitarbeiter- und Kundenrollen standardmäßig zustehen.Sicherheit und KontoErstellen Sie eine benutzerdefinierte RolleFügen Sie eine Rolle wie Senior Paralegal oder Co-Anwalt hinzu, beginnen Sie mit einer Voreinstellung und wählen Sie dann deren Berechtigungen und Dateibeschränkungen aus.Sicherheit und Konto · 10 min