JWT-Lesegruppen

JWT-Lesegruppen ermöglichen es Ihnen, zu steuern, auf welche Bereiche Ihrer privaten Wissensdatenbank jeder authentifizierte Leser zugreifen kann. Wenn ein Reader sich über JWT SSO anmeldet, verwendet Document360 die Lesergruppen-IDs in seinem Token-Payload, um zu bestimmen, welche Projektversionen, Sprachen, Kategorien und Artikel er anzeigen darf.

Eine JWT-Lesergruppe ist identisch mit einer regulären Document360-Lesergruppe. Es erbt die gleichen Einschränkungseinstellungen. Der einzige Unterschied ist, wie die Zuweisung funktioniert: Anstatt Leser manuell im Portal zuzuweisen, gibt man deren Gruppen-IDs direkt in die JWT-Nutzlast weiter.

Wann man JWT-Lesegruppen verwenden sollte

Nutze JWT-Lesergruppen, wenn du inhaltsbasierte Zugriffsbeschränkungen für Leser durchsetzen musst, die sich über JWT SSO authentifizieren.

Beispielszenario:

Ihr Vertriebsteam benötigt Zugang zu Preis- und Abrechnungsartikeln, sollte aber keinen Zugriff auf API-Dokumentation oder technische Kernartikel haben.

Lösung:

1. Erstelle eine Lesergruppe im privaten Document360-Projekt, die nur Zugriff auf die Preiskategorie gewährt.
2. Weisen Sie die Vertriebsteammitglieder dieser Lesergruppe zu.

Weitere häufige Szenarien sind:

• Eine Kundenebene, die nur auf Onboarding-Anleitungen zugreifen kann, nicht auf fortgeschrittene Konfigurationsinhalte.
• Mehrere Nutzersegmente, die unterschiedliche Ansichten derselben privaten Wissensdatenbank benötigen.

Wenn Ihre Wissensdatenbank öffentlich ist oder alle authentifizierten Leser denselben Inhalt sehen sollten, ist eine Zuweisung für die Lesergruppe nicht erforderlich.

Bevor du anfängst

• Dein Projekt muss JWT SSO konfiguriert haben. Falls du es noch nicht eingerichtet hast, siehe JWT konfigurieren in Document360.
• Mindestens eine Lesergruppe muss in Ihrem Projekt vorhanden sein. Sie können Lesergruppen über Einstellungen > Benutzer & Berechtigungen > Leser & Gruppen > Reiter Lesergruppen erstellen und verwalten.
• Sie müssen eine Rolle als Projektverantwortlicher oder Administrator haben, um auf die Lesergruppeneinstellungen zugreifen zu können.

Schritt 1: Holen Sie sich Ihre Lesergruppen-ID

Jede Lesergruppe in Document360 hat eine eindeutige ID, die Sie in die JWT-Nutzlast aufnehmen, um Leser dieser Gruppe zuzuweisen.

1. Gehe zu Einstellungen > Benutzer & Berechtigungen > Leser & Gruppen.
2. Wählen Sie den Reiter Lesergruppen aus.
3. Finden Sie die Lesegruppe, die Sie verwenden möchten. Die Gruppen-ID wird unter dem Gruppennamen angezeigt.
4. Klicken Sie auf das Kopieren-Symbol , um die Gruppen-ID in Ihre Zwischenablage zu kopieren.

Schritt 2: Fügen Sie Lesergruppen-IDs Ihrer JWT-Nutzlast hinzu

Sobald du die Gruppen-ID hast, füge sie im readerGroupIds Feld deiner JWT-Nutzlast ein.

Verwenden Sie folgendes JSON-Format:

{
  "username": "firstname + lastname",
  "firstName": "firstname",
  "lastName": "lastname",
  "emailId": "user emailId",
  "readerGroupIds": [
    "26b3812e-7879-4407-b1c9-5755c32b886a",
    "674eadcd-793f-4131-b1e0-c1f055cc83b7"
  ],
  "tokenValidity": 15
}

Um einen Leser mehreren Gruppen zuzuweisen, fügen Sie jede Gruppen-ID als separaten Eintrag im Array hinzu, getrennt durch Kommas.

Beispiel für mehrere Gruppen:

"readerGroupIds": ["26b3812e-7879-4407-b1c9-5755c32b886a", "674eadcd-793f-4131-b1e0-c1f055cc83b7"]

Das Feld legt in Minuten tokenValidity fest, wie lange der Token gültig bleibt. Der Mindestwert beträgt 5 Minuten und der Maximum 1440 Minuten (1 Tag).

Wenn der Leser sich authentifiziert und auf die Wissensdatenbank zuruft, gelten die in seiner zugewiesenen Lesergruppe definierten Einschränkungen automatisch. Sie können nur die Projektversionen, Sprachen, Kategorien und Artikel einsehen, die von der jeweiligen Gruppe erlaubt sind.

Zeitpunkt der Änderungen

Änderungen der Lesergruppen-IDs in der Nutzlast (Ergänzungen oder Entfernungen) treten erst nach Ablauf der aktuellen Sitzung des Lesers in Kraft, basierend auf der Token-Gültigkeitsperiode.

Beispiel: Wenn die Token-Gültigkeit auf 30 Minuten gesetzt wird und Sie eine neue Gruppen-ID zur Nutzlast hinzufügen, gilt die Änderung erst, wenn 30 Minuten vergangen sind. Dasselbe gilt beim Entfernen einer Gruppen-ID.

Best Practices

• Halte die Token-Gültigkeit so kurz wie möglich für deinen Anwendungsfall. Eine kürzere Gültigkeit bedeutet, dass Zugangsänderungen früher in Kraft treten.
• Überprüfen Sie regelmäßig Ihre Lesergruppenaufgaben, um sicherzustellen, dass die Leser keinen Zugriff mehr auf Inhalte behalten, die sie nicht mehr benötigen.
• Verwenden Sie das Kopier-Symbol im Portal, um Gruppen-IDs direkt einzufügen und so manuelle Transkriptionsfehler zu vermeiden.
• Test-Lesergruppenzuweisung nach jeder Payload-Änderung durch Anmeldung als Testleser-Account, um sicherzustellen, dass die Zugriffsbeschränkungen wie erwartet angewendet werden.

FAQ