Skip to main content
Les offres Pro incluent l’authentification par mot de passe.Les offres Enterprise incluent toutes les méthodes d’authentification.
Choisissez parmi trois approches pour gérer l’accès et personnaliser votre documentation selon les informations des utilisateurs et vos besoins en matière de sécurité :
  • Authentification complète : protection totale de la confidentialité de l’ensemble du contenu, avec personnalisation complète.
  • Authentification partielle : contrôle d’accès page par page, avec personnalisation complète.
  • Personnalisation : personnalisation du contenu sans aucune garantie de sécurité. Tout le contenu reste publiquement accessible.

Exemples de cas d’utilisation

Choisissez l’authentification complète lorsque :
  • Vous créez une documentation interne à l’entreprise contenant des informations sensibles
  • Vous documentez des API propriétaires nécessitant une vérification des utilisateurs
  • Vous rédigez des guides de mise en œuvre spécifiques à des clients
Choisissez l’authentification partielle lorsque :
  • Vous proposez des guides de démarrage publics avec des fonctionnalités avancées privées
  • Vous publiez une documentation open source avec des sections privées pour l’entreprise
Choisissez la personnalisation lorsque :
  • Vous créez une documentation d’API publique qui affiche des exemples propres à chaque utilisateur
  • Vous concevez des sites marketing qui personnalisent le contenu en fonction des profils utilisateurs
  • Vous proposez des tutoriels publics qui s’adaptent aux préférences ou au niveau de compétence de l’utilisateur

Méthodes de handshake

Choisissez la méthode qui correspond le mieux à votre infrastructure existante et à vos exigences de sécurité.
MéthodeDisponible pourComplexité de configurationIdéale pour
JWT (JSON Web Token)Toutes les approchesMoyenneParcours de connexion personnalisés, contrôle maximal sur la sécurité
OAuth 2.0Toutes les approchesÉlevéeFournisseurs d’authentification tiers, sécurité de niveau entreprise
Mintlify DashboardAuthentification uniquementFaibleÉquipes utilisant déjà le Tableau de bord Mintlify
Mot de passeAuthentification uniquementFaibleAccès partagé simple sans personnalisation
Session partagéePersonnalisation uniquementFaibleApplications avec authentification par session existante

Quand utiliser chaque méthode

JWT: À utiliser si vous disposez déjà d’un système d’authentification et souhaitez garder un contrôle total sur le parcours de connexion. Idéal pour une gestion des utilisateurs sur mesure ou lorsque vous devez dissocier l’accès à la documentation de votre application principale. OAuth 2.0: À utiliser si vous souhaitez tirer parti de fournisseurs d’authentification tiers (Google, GitHub, etc.) ou si vous avez besoin de normes de sécurité de niveau entreprise. Idéal pour les organisations qui utilisent déjà une infrastructure OAuth. Mintlify Dashboard: À utiliser lorsque vos éditeurs de documentation sont aussi vos lecteurs. Parfait pour les équipes internes qui gèrent déjà le contenu via le Tableau de bord Mintlify. Mot de passe: À utiliser pour un contrôle d’accès simple lorsque vous n’avez pas besoin de suivre des utilisateurs individuellement ni de personnaliser le contenu. Pratique pour les prestataires, les bêta‑testeurs ou les accès temporaires. Session partagée: À utiliser si vous souhaitez une connexion fluide entre votre application et la documentation. Idéal lorsque les utilisateurs sont déjà authentifiés dans votre application principale et que vous souhaitez personnaliser leur expérience de la documentation.

Personnalisation du contenu

Les trois approches prennent en charge des fonctionnalités de personnalisation du contenu, notamment du contenu MDX dynamique, le préremplissage de la clé API et des contrôles de visibilité des pages. Pour des conseils de mise en œuvre détaillés, consultez Configuration de la personnalisation.
I