Documentation Index

Fetch the complete documentation index at: https://docs.document360.com/llms.txt

Use this file to discover all available pages before exploring further.

Clause de non-responsabilité: Cet article a été généré par traduction automatique.

Groupes de lecteurs JWT

Prev Next

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

Un groupe de lecteurs JWT est identique à un groupe de lecteurs Document360 classique. Il hérite des mêmes paramètres de restriction. La seule différence est la façon dont fonctionne l’attribution : 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 :

Votre équipe commerciale a besoin d’accéder aux articles de tarification et de facturation, mais elle ne devrait pas avoir accès à la documentation API ni aux articles techniques de base.

Solution :

  1. Créez un groupe de lecteurs dans le projet privé Document360, en n’accordant accès qu’à la catégorie tarifaire.
  2. Attribuez les membres de l’équipe commerciale à ce groupe de lecteurs.

D’autres scénarios courants incluent :

  • Un niveau client qui ne peut accéder qu’aux guides d’intégration, pas au contenu de configuration avancé.
  • Plusieurs segments d’utilisateurs qui ont besoin de différentes vues 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é le SSO JWT. 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 et 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.
NOTE

Les identifiants de groupes de lecteurs ne sont disponibles que pour les projets configurés par JWT. Ils ne sont pas visibles sur les projets de base de connaissances privées classiques sans JWT.


É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 & groupes.
  2. Sélectionnez l’onglet Groupes de lecteurs .
  3. Trouvez 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.
Reader groups interface showing Group ID below each group name with a copy icon.

É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": "firstname + lastname",
  "firstName": "firstname",
  "lastName": "lastname",
  "emailId": "user emailId",
  "readerGroupIds": [
    "26b3812e-7879-4407-b1c9-5755c32b886a",
    "674eadcd-793f-4131-b1e0-c1f055cc83b7"
  ],
  "tokenValidity": 15
}

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 durée maximale de 1440 minutes (1 jour).

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. Ils ne peuvent consulter que les versions du projet, les langues, les catégories et les articles autorisés par ce groupe.


Calendrier des changements

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.

NOTE

Planifiez tout changement de groupe de lecteurs en tenant compte de ce délai, surtout si vous devez que des changements d’accès prennent effet immédiatement pour un lecteur spécifique.


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

Un lecteur peut-il appartenir à plus d’un groupe de lecteurs ?

Oui. Vous pouvez inclure plusieurs identifiants de groupe dans le readerGroupIds tableau. Le lecteur héritera des autorisations d’accès combinées de tous les groupes assignés.

Pourquoi ne puis-je pas voir l’identifiant de groupe dans mon projet ?

Les identifiants de groupe de lecteurs ne sont visibles que dans les projets configurés par JWT. Si votre projet n’a pas JWT SSO activé, le champ ID de groupe n’apparaîtra pas sous l’onglet Groupes de lecteurs.

Que se passe-t-il si j’ajoute un identifiant de groupe invalide à la charge utile ?

Le jeton sera toujours généré, mais l’ID de groupe invalide ne sera mappé à aucun groupe. Le lecteur peut ne pas avoir les restrictions d’accès attendues appliquées. Vérifiez toujours les identifiants de groupe en les copiant directement depuis le portail.

Si je retire un identifiant de groupe de la charge utile, le lecteur perd-il l’accès immédiatement ?

Non. Les modifications n’entrent en vigueur qu’après l’expiration du jeton actuel. Si la validité du token est fixée à 30 minutes, des changements d’accès s’appliqueront après 30 minutes à partir de la dernière émission du token.