Configuration de l'authentification

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

Vous pouvez configurer une authentification complète pour toutes les pages ou une authentification partielle où certaines pages sont publiques et d’autres nécessitent une authentification.

L’authentification n’est disponible que pour les sites hébergés sur un domaine personnalisé ou un sous-domaine Mintlify. Par exemple, docs.exemple.com ou exemple.mintlify.site. L’authentification n’est pas prise en charge pour les sites avec un sous-chemin personnalisé. Par exemple, exemple.com/docs.

Utilisez ce comparatif pour choisir la méthode adaptée à votre cas d’usage. Consultez Disponibilité des fonctionnalités pour savoir comment chaque méthode interagit avec les autres fonctionnalités de Mintlify.

Lorsque vous utilisez l’authentification, toutes les pages nécessitent par défaut une authentification pour y accéder. 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.

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

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

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.

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

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.

Gérez les groupes via les données utilisateur transmises lors de l’authentification. Voir Format des données utilisateur pour plus de détails.

{
  "groups": ["admin", "beta-users"],
  "expiresAt": 1735689600
}

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

---
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.

• Par défaut, toutes les pages nécessitent une authentification.
• Les pages comportant une propriété groups ne sont accessibles qu’aux utilisateurs authentifiés appartenant à ces groupes.
• Les pages sans propriété groups sont accessibles à tous les utilisateurs authentifiés.
• Les pages avec public: true et sans propriété groups sont accessibles à tout le monde.

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

Lorsque vous utilisez l’authentification OAuth ou JWT, votre système renvoie des données utilisateur qui contrôlent la durée de la session et l’appartenance à des groupes pour le contrôle d’accès, ainsi que la personnalisation du contenu.

type User = {
  host?: string;
  expiresAt?: number;
  groups?: string[];
  content?: Record<string, any>;
  apiPlaygroundInputs?: {
    server?: Record<string, string>;
    header?: Record<string, unknown>;
    query?: Record<string, unknown>;
    cookie?: Record<string, unknown>;
    path?: Record<string, unknown>;
  };
};

Certaines fonctionnalités se comportent différemment ou ne sont pas disponibles lorsque vous activez l’authentification. Mintlify ne prend pas en charge l’hébergement de fichiers publics arbitraires sur un site authentifié. Tous les fichiers hébergés, y compris llms.txt, llms-full.txt et skill.md, sont soumis aux mêmes exigences d’authentification que vos pages de documentation.