Aperçu

Contrôlez qui peut consulter votre documentation et personnalisez son expérience

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

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

Choisissez l’une des trois approches pour gérer l’accès et personnaliser votre documentation en fonction des informations utilisateur et de vos exigences de sécurité :

• Authentification complète : Confidentialité totale 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 d’usage

Choisissez l’authentification complète lorsque :

• Vous créez une documentation interne contenant des informations sensibles
• Vous documentez des API propriétaires nécessitant la 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 publics de prise en main avec des fonctionnalités avancées privées
• Vous offrez un produit freemium où les utilisateurs premium disposent d’une documentation supplémentaire
• Vous publiez une documentation open source avec des sections enterprise privées

Choisissez la personnalisation lorsque :

• Vous créez une documentation API publique affichant des exemples propres à chaque utilisateur
• Vous concevez des sites marketing qui personnalisent le contenu selon le profil des utilisateurs
• Vous proposez des tutoriels publics qui s’adaptent aux préférences ou au niveau de compétence de l’utilisateur

Méthodes d’authentification (handshake)

Choisissez la méthode qui correspond le mieux à votre infrastructure existante et à vos exigences de sécurité.

Méthode	Disponible pour	Complexité de configuration	Idéale pour
JWT	Toutes les approches	Moyenne	Parcours de connexion personnalisés, contrôle de sécurité maximal
OAuth 2.0	Toutes les approches	Élevée	Fournisseurs d’authentification tiers, sécurité d’entreprise
Mintlify Dashboard	Authentification uniquement	Faible	Équipes utilisant déjà le tableau de bord Mintlify
Mot de passe	Authentification uniquement	Faible	Accès partagé simple, sans personnalisation
Session partagée	Personnalisation uniquement	Faible	Applications avec authentification existante basée sur des sessions

Quand utiliser chaque méthode

JWT : À utiliser si vous disposez d’un système d’authentification existant et souhaitez un contrôle total sur le parcours de connexion. Idéal pour une gestion des utilisateurs personnalisée ou lorsque vous devez découpler 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 utilisant 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 les utilisateurs individuellement ni de personnaliser le contenu. Pratique pour les prestataires, les bêta-testeurs ou les accès temporaires.

Session partagée : À utiliser lorsque vous souhaitez une connexion transparente 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, notamment du contenu MDX dynamique, le préremplissage des clés API et le contrôle de la visibilité des pages. Pour des conseils de mise en œuvre détaillés, consultez Configuration de la personnalisation.