Passer au contenu principal
Les formules Pro incluent l’authentification par mot de passe.Les formules Enterprise incluent toutes les méthodes d’authentification.
L’authentification impose aux utilisateurs de se connecter avant d’accéder à votre documentation.

​
Modes d’authentification

Choisissez entre les modes d’authentification complète et partielle en fonction de vos besoins en matière de 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 aux pages protégées. Lors de la configuration de l’une des méthodes de handshake ci-dessous, vous sélectionnerez soit Authentification complète soit Authentification partielle dans les paramètres de votre Dashboard.

​
Configuration de l’authentification

Sélectionnez la méthode d’échange (handshake) que vous souhaitez configurer.
  • Mot de passe
  • Tableau de bord Mintlify
  • OAuth 2.0
  • JWT (JSON Web Token)
L’authentification par mot de passe assure uniquement le 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, accédez à 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 en toute sécurité 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 souhaitez 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 voilà !

​
Rendre des pages publiques

Lorsque vous utilisez l’authentification partielle, toutes les pages sont protégées par défaut. Vous pouvez rendre certaines pages accessibles sans authentification au niveau de la page ou du groupe avec la propriété public.

​
Au niveau de la page

Pour rendre une page publique, ajoutez public: true au frontmatter de la page.
Public page example
---
title: "Page publique"
public: true
---

​
Niveau groupe

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"
        ]
      }
    ]
  }
}
⌘I