Configuration de l'authentification

Contrôlez l’accès à votre documentation en authentifiant les utilisateurs.

Les offres Pro incluent l’authentification par mot de passe.

Les offres Custom incluent toutes les méthodes d’authentification.

L’authentification exige que les utilisateurs se connectent avant d’accéder à votre documentation.

​

Modes d’authentification

Choisissez entre les modes d’authentification complet ou partiel selon vos besoins en contrôle d’accès.

Authentification complète : Toutes les pages sont protégées. Les utilisateurs doivent se connecter avant d’accéder à tout contenu.

Authentification partielle : Certaines pages sont publiques, tandis que d’autres nécessitent une authentification. Les utilisateurs peuvent parcourir librement le contenu public et ne s’authentifier que lorsqu’ils accèdent à des pages protégées.

Lors de la configuration de l’une des méthodes de handshake ci‑dessous, sélectionnez Authentification complète ou Authentification partielle dans les paramètres du Dashboard.

​

Configurer l’authentification

Sélectionnez la méthode de poignée de main que vous souhaitez configurer.

Mot de passe

L’authentification par mot de passe fournit uniquement un contrôle d’accès et ne prend pas en charge la personnalisation du contenu.

​

Prérequis

• Vos exigences de sécurité autorisent le partage de mots de passe entre utilisateurs.

​

Mise en œuvre

1. Créer un mot de passe.

   1. Dans votre Dashboard, allez sur Authentification.
   2. Sélectionnez Authentification complète ou Authentification partielle.
   3. Sélectionnez Mot de passe.
   4. Saisissez un mot de passe sécurisé.
   5. Sélectionnez Enregistrer les modifications.
2. Distribuer l’accès.

   Partagez de manière sécurisée le mot de passe et l’URL de la documentation avec les utilisateurs autorisés.

​

Exemple

Votre documentation est hébergée sur docs.foo.com et vous avez besoin d’un contrôle d’accès simple sans suivi des utilisateurs individuels. Vous voulez empêcher l’accès public tout en gardant une configuration simple.

Créez un mot de passe robuste dans votre Dashboard. Partagez les identifiants avec les utilisateurs autorisés. Et c’est tout !

​

Rendre des pages publiques

Lorsque vous utilisez l’authentification partielle, toutes les pages sont protégées par défaut. Vous pouvez autoriser l’accès à certaines pages sans authentification, au niveau de la page ou du groupe, à l’aide de la propriété public.

​

Pages individuelles

Pour rendre une page publique, ajoutez public: true au frontmatter de la page.

Public page example

---
title: "Page publique"
public: true
---

​

Groupes de pages

Pour rendre toutes les pages d’un groupe publiques, ajoutez “public”: true sous le nom du groupe dans l’objet navigation de votre docs.json.

Public group example

{
  "navigation": {
    "groups": [
      {
        "group": "Groupe public",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "Groupe privé",
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}

​

Contrôler l’accès avec des groupes

Lorsque vous utilisez l’authentification OAuth ou des JWT (JSON Web Tokens), vous pouvez restreindre certaines pages à des groupes d’utilisateurs spécifiques. C’est utile si vous souhaitez que différents utilisateurs voient des contenus différents selon leur rôle ou leurs attributs.

Les groupes sont gérés via les données utilisateur transmises lors de l’authentification.

Example user info

{
  "groups": ["admin", "beta-users"],
  "content": {
    "firstName": "Jane",
    "lastName": "Doe"
  }
}

Indiquez quels groupes peuvent accéder à des pages spécifiques à l’aide de la propriété groups dans le frontmatter.

Example page restricted to the admin group

---
title: "Dashboard administrateur"
groups: ["admin"]
---

Les utilisateurs doivent appartenir à au moins un des groupes répertoriés pour accéder à la page. Si un utilisateur tente d’accéder à une page sans le groupe requis, il recevra une erreur 404.

​

Interaction avec les modes d’authentification

Les groupes fonctionnent différemment selon votre mode d’authentification.

Authentification complète avec groupes :

• Toutes les pages nécessitent une authentification.
• Les pages sans propriété groups sont accessibles à tous les utilisateurs authentifiés.
• Les pages avec une propriété groups ne sont accessibles qu’aux utilisateurs authentifiés appartenant à ces groupes.

Authentification partielle avec groupes :

• Les pages nécessitent une authentification, sauf si vous les rendez publiques.
• Les pages avec public: true et sans groups sont accessibles à tout le monde.
• Les pages avec groups (avec ou sans public: true) ne sont accessibles qu’aux utilisateurs authentifiés appartenant à ces groupes.

Anyone can view this page

---
title: "Guide public"
public: true
---

Only authenticated users can view this page

---
title: "Référence API"
---

```mdx Seuls les utilisateurs authentifiés des groupes pro ou enterprise peuvent consulter cette page
---
title: "Configurations avancées"
groups: ["pro", "enterprise"]
---