L’authentification privée pour votre organisation Mintlify est disponible sur toutes les offres.L’authentification par mot de passe nécessite une offre Pro ou Enterprise.L’authentification OAuth et JWT nécessite une offre Enterprise.
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.
Lorsque vous activez l’authentification, vous pouvez supprimer les déploiements d’aperçu existants qui resteraient sinon accessibles publiquement. Consultez Aperçus existants lors de l’activation de l’authentification.
Pour identifier les visiteurs tout en gardant les pages publiques, utilisez la personnalisation. La personnalisation prend en charge les sous-chemins personnalisés et peut préremplir les entrées du bac à sable d’API sans obliger les visiteurs à s’authentifier avant de consulter une page.
Choisir une méthode d’authentification
Configurer l’authentification
- Mot de passe
- Authentification privée
- OAuth 2.0
- JWT
L’authentification par mot de passe fournit uniquement un contrôle d’accès et ne prend pas en charge les fonctionnalités spécifiques aux utilisateurs comme le contrôle d’accès basé sur les groupes ou le pré-remplissage du bac à sable d’API.
Prérequis du mot de passe
- Vos exigences de sécurité autorisent le partage de mots de passe entre les utilisateurs.
Configuration du mot de passe
1
Créer un mot de passe.
- Dans votre Dashboard, accédez à Access.
- Définissez Visibility sur Private.
- Définissez Method sur Password.
- Saisissez un mot de passe sécurisé.
- Cliquez sur Save.
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 de mot de passe
docs.foo.com et vous avez besoin d’un contrôle d’accès de base sans suivi des utilisateurs individuels. Vous voulez empêcher l’accès public tout en gardant la configuration simple.Créez un mot de passe robuste dans votre Dashboard. Partagez les identifiants de connexion avec les utilisateurs autorisés.Rendre des pages publiques
public.
Pages individuelles
public: true au frontmatter de la page.
Public page example
Groupes de pages
navigation de votre docs.json.
Public group example
Contrôler l’accès avec des groupes
Example user info
groups dans le frontmatter.
Example page restricted to the admin group
groups au niveau de la page pour le contenu sensible.
Fonctionnement des groupes avec les pages publiques
- Par défaut, toutes les pages nécessitent une authentification.
- Les pages comportant une propriété
groupsne sont accessibles qu’aux utilisateurs authentifiés appartenant à ces groupes. - Les pages sans propriété
groupssont accessibles à tous les utilisateurs authentifiés. - Les pages avec
public: trueet sans propriétégroupssont accessibles à tout le monde.
Format des données utilisateur
string
Requis pour l’authentification JWT. Le nom d’hôte de votre site de documentation. La chaîne doit correspondre exactement au domaine sur lequel vous déployez votre documentation. Mintlify valide que l’hôte du JWT correspond à l’hôte de la requête afin d’empêcher la réutilisation du jeton sur différents sites.
number
Heure d’expiration de la session, en secondes depuis l’époque Unix. Lorsque l’heure actuelle dépasse cette valeur, Mintlify expire les données utilisateur stockées. Le visiteur doit alors s’authentifier à nouveau ou répéter le flux d’identification pour les actualiser.
string[]
Liste des groupes auxquels l’utilisateur appartient. Avec l’authentification, les pages dont le frontmatter contient un
groups correspondant sont accessibles à cet utilisateur. Avec la personnalisation autonome, les groupes contrôlent la visibilité des pages et du contenu, mais ne restreignent pas l’accès à l’URL directe d’une page.Exemple : Un utilisateur avec groups: ["admin", "engineering"] correspond aux contenus étiquetés avec les groupes admin ou engineering.Record<string, any>
Données personnalisées accessibles dans les pages MDX via la variable
user pour le contenu personnalisé.object
Préremplit les champs du bac à sable d’API avec des valeurs propres à l’utilisateur. Lorsqu’un utilisateur s’authentifie, ces valeurs renseignent les champs de saisie correspondants dans le bac à sable d’API. Les utilisateurs peuvent remplacer les valeurs préremplies, et leurs remplacements sont conservés dans le stockage local.Mintlify n’applique que les valeurs qui correspondent au schéma de sécurité du point de terminaison actuel.
Disponibilité des fonctionnalités
llms.txt, llms-full.txt et skill.md, sont soumis aux mêmes exigences d’authentification que vos pages de documentation.