Groupes de lecteurs JWT

Les groupes de lecteurs JWT vous permettent de contrôler quelles sections de votre base de connaissances privées chaque lecteur authentifié peut consulter. Lorsqu’un lecteur se connecte via JWT SSO, Document360 utilise les identifiants des groupes de lecteurs dans leur charge utile de jetons pour déterminer quelles versions de projet, langages, catégories et articles ils sont autorisés à consulter.

Un groupe de lecture JWT est identique à un groupe de lecture Document360 classique. Il hérite des mêmes paramètres de restriction. La seule différence réside dans le fonctionnement de l’affectation : au lieu d’assigner manuellement les lecteurs dans le portail, vous passez directement leurs identifiants de groupe dans la charge utile JWT.

Quand utiliser les groupes de lecture JWT

Utilisez les groupes de lecteurs JWT lorsque vous devez imposer des restrictions d’accès basées sur le contenu pour les lecteurs qui s’authentifient via JWT SSO.

Exemple de scénario :
Vous vendez un add-on de niveau entreprise avec sa propre configuration et sa propre documentation API. Seuls les clients ayant acheté cet add-on devraient consulter ces articles. Tous les autres ne devraient consulter que la documentation standard.

Solution :

1. Créez un groupe de lecture dans le projet privé Document360, en n’accordant l’accès qu’à la catégorie d’extensions entreprise.
2. Attribuez les lecteurs à ce groupe en fonction de leur niveau d’abonnement (transmis via les réclamations JWT lors de la connexion SSO).

D’autres scénarios courants incluent :

• Un guide d’intégration des partenaires visible uniquement aux lecteurs des organisations partenaires, et non aux clients généraux.
• La documentation des fonctionnalités bêta est restreint aux clients inscrits au programme bêta.
• Plusieurs segments de clients (par exemple, différents SKU régionaux de produits) qui ont besoin de différents points de vue sur la même base de connaissances privée.

Si votre base de connaissances est publique ou si tous les lecteurs authentifiés devraient voir le même contenu, la mission de groupe de lecteurs n’est pas obligatoire.

Avant que tu commences

• Votre projet doit avoir configuré JWT SSO. Si vous ne l’avez pas encore configuré, consultez Configurer JWT dans Document360.
• Au moins un groupe de lecteurs doit exister dans votre projet. Vous pouvez créer et gérer des groupes de lecteurs depuis Paramètres () > Utilisateurs & permissions > Lecteurs & groupes >onglet Groupes de lecteurs .
• Vous devez avoir un rôle de Chef de projet ou d’administrateur pour accéder aux paramètres du groupe de lecteurs.

Étape 1 : Obtenez votre identifiant de groupe de lecteurs

Chaque groupe de lecteurs dans Document360 possède un ID unique que vous incluez dans la charge utile JWT pour assigner les lecteurs à ce groupe.

1. Va dans Paramètres () > Utilisateurs et permissions > Lecteurs et groupes.
2. Sélectionnez l’onglet Groupes de lecteurs .
3. Localisez le groupe de lecteurs que vous souhaitez utiliser. L’identifiant du groupe est affiché sous le nom du groupe.
4. Cliquez sur l’icône Copier pour copier l’identifiant de groupe dans votre clipboard.

Étape 2 : Ajoutez des identifiants de groupe de lecteurs à votre charge utile JWT

Une fois que vous avez l’ID de groupe, incluez-le dans le readerGroupIds champ de votre charge utile JWT.

Utilisez le format JSON suivant :

{
  "username": "john.doe",
  "firstName": "John",
  "lastName": "Doe",
  "emailId": "john.doe@example.com",
  "readerGroupIds": [
    "26b3812e-7879-4407-b1c9-5755c32b886a",
    "674eadcd-793f-4131-b1e0-c1f055cc83b7"
  ],
  "tokenValidity": 15,
  "providerName": "app.example.com"
}

Pour assigner un lecteur à plusieurs groupes, ajoutez chaque identifiant de groupe comme une entrée distincte dans le tableau, séparée par des virgules.

Exemple pour plusieurs groupes :

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

Le tokenValidity champ indique combien de temps le jeton reste valide, en minutes. La valeur minimale est de 5 minutes et la maximale de 1440 minutes (1 jour).

Le providerName champ n’est requis que si votre projet possède plusieurs configurations JWT. Définissez-le sur le Domaine de la configuration JWT correspondante. Pour plus d’informations, voir Re-authentifier les lecteurs avec plusieurs configurations JWT.

Lorsque le lecteur authentifie et accède à la base de connaissances, les restrictions définies dans son groupe de lecteurs assignés s’appliquent automatiquement. Il ne peut consulter que les versions du projet, les langues, les catégories et les articles autorisés par ce groupe.

Lorsque les changements de groupe de lecteurs prennent effet

Les modifications des identifiants de groupes de lecteurs dans la charge utile (ajouts ou suppressions) n’entrent en vigueur qu’après l’expiration de la session actuelle du lecteur, en fonction de la période de validité du jeton.

Exemple : Si la validité du jeton est fixée à 30 minutes et que vous ajoutez un nouvel identifiant de groupe à la charge utile, le changement ne s’appliquera qu’après 30 minutes. Il en va de même pour la suppression d’un identifiant de groupe.

Accès linguistique pour les lecteurs JWT dans le widget

Lorsque l’authentification JWT est configurée pour le widget, la visibilité du contenu est déterminée par les autorisations attribuées au lecteur authentifié et les filtres d’accès au contenu configurés à l’intérieur du widget. Lors de la connexion, le système valide les autorisations du lecteur par rapport aux paramètres d’accès au contenu du widget. Seules les permissions qui se chevauchent entre le groupe de lecteurs et la configuration du widget sont prises en compte lors de la détermination du contenu auquel le lecteur peut accéder.

Si un lecteur appartient à un groupe de lecteurs disposant de permissions au niveau de la langue, le widget affiche le contenu uniquement dans les langues disponibles via ce groupe de lecteurs, même si le widget lui-même est configuré avec un accès plus large, comme l’accès au niveau du projet.

Permettre aux lecteurs d’accéder à des contenus en plusieurs langues

1. Configurez le groupe de lecteurs avec toutes les langues qui devraient être disponibles pour le lecteur lors de la connexion.
2. Vérifiez que les paramètres d’accès au contenu du widget ne restreignent pas l’accès à un ensemble de contenus plus restreint.

Meilleures pratiques

• Gardez la validité du token aussi courte que possible pour votre cas d’usage. Une validité plus courte signifie que les changements d’accès prennent effet plus tôt.
• Auditez régulièrement vos devoirs de groupe de lecteurs pour vous assurer que les lecteurs ne gardent pas accès à un contenu dont ils n’ont plus besoin.
• Utilisez l’icône de copie dans le portail pour coller directement les identifiants de groupe, évitant ainsi les erreurs de transcription manuelle.
• Assignation de groupe de lecteurs de test après tout changement de charge utile en se connectant en tant que compte lecteur de test pour confirmer que les restrictions d’accès sont appliquées comme prévu.

FAQ