Passer au contenu principal
L’authentification par e-mail nécessite un forfait Enterprise.
L’authentification par e-mail vous permet de donner accès à votre documentation privée à des clients, des partenaires et d’autres personnes extérieures à votre organisation, sans gérer votre propre fournisseur d’identité. Vous invitez les lecteurs par e-mail, vous les répartissez dans des groupes, et Mintlify héberge la page de connexion, les réinitialisations de mot de passe et les codes de connexion. Utilisez l’authentification par e-mail lorsque :
  • Les personnes qui lisent vos pages n’ont pas de compte dans un fournisseur d’identité que vous contrôlez.
  • Vous souhaitez un accès individuel que vous pouvez révoquer, plutôt qu’un mot de passe partagé.
  • Vous souhaitez afficher des pages différentes selon les lecteurs grâce aux groupes.
Si vos lecteurs se connectent déjà à votre produit, utilisez plutôt OAuth ou JWT afin qu’ils conservent un seul compte.

​
Activer l’authentification par e-mail

1

Choisissez la méthode par e-mail.

  1. Dans votre dashboard, accédez à Access.
  2. Définissez Visibility sur Private.
  3. Définissez Method sur Emails.
2

Choisissez comment les lecteurs se connectent.

Activez une ou les deux méthodes de connexion :
  • Email and password : les lecteurs définissent un mot de passe depuis leur e-mail d’invitation et peuvent le réinitialiser eux-mêmes.
  • Sign-in code : les lecteurs reçoivent par e-mail un code à usage unique de 6 chiffres à chaque connexion.
3

(Facultatif) Personnalisez l'apparence des e-mails destinés aux lecteurs.

Sous Reader emails, définissez l’apparence des invitations, des réinitialisations de mot de passe et des codes de connexion :
  • From name : le nom d’expéditeur que voient les lecteurs, par exemple Acme Docs. Par défaut, il s’agit du nom de votre site.
  • Reply-to : l’adresse qui reçoit les réponses, par exemple support@acme.com.
  • Logo URL : une URL https:// pour le logo affiché en haut de chaque e-mail.
  • Brand color : la couleur des boutons de chaque e-mail.
4

Enregistrez.

Cliquez sur Save. Une fois votre site redéployé, les visiteurs doivent se connecter pour lire votre documentation.
La page de paramètres Access avec la méthode Emails sélectionnée. Email and password et Sign-in code sont activés, les règles de domaine attribuent le groupe customers aux lecteurs acme.com, et les e-mails destinés aux lecteurs utilisent le nom d'expéditeur Acme Docs.La page de paramètres Access avec la méthode Emails sélectionnée. Email and password et Sign-in code sont activés, les règles de domaine attribuent le groupe customers aux lecteurs acme.com, et les e-mails destinés aux lecteurs utilisent le nom d'expéditeur Acme Docs.

​
Ajouter des lecteurs

Les lecteurs sont les personnes qui peuvent se connecter à votre site. Gérez-les dans la section Readers de vos paramètres Access.
Le tableau Readers listant cinq lecteurs avec leurs groupes, leur statut, la date de leur dernière connexion et la date de fin d'accès.Le tableau Readers listant cinq lecteurs avec leurs groupes, leur statut, la date de leur dernière connexion et la date de fin d'accès.

​
Inviter des lecteurs

  1. Cliquez sur Invite.
  2. Saisissez une ou plusieurs adresses e-mail, une par ligne.
  3. Si vous le souhaitez, saisissez des groupes séparés par des virgules et une date Access until.
  4. Cliquez sur Send invites.
Chaque lecteur reçoit un e-mail contenant un lien pour définir un mot de passe ou se connecter. Les liens d’invitation expirent au bout de sept jours. Les lecteurs apparaissent comme Invited jusqu’à leur première connexion, puis comme Active.
La boîte de dialogue Invite readers avec deux adresses e-mail acme.com, les groupes customers et beta, et une date Access until vide.La boîte de dialogue Invite readers avec deux adresses e-mail acme.com, les groupes customers et beta, et une date Access until vide.

​
Importer des lecteurs depuis un fichier CSV

Pour ajouter de nombreux lecteurs à la fois, cliquez sur Import CSV et choisissez un fichier comportant ces colonnes :
readers.csv
  • email : obligatoire.
  • groups : facultatif. Séparez plusieurs groupes avec ; ou |.
  • access_until : facultatif. Une date telle que 2026-12-31.
La ligne d’en-tête est facultative. L’importation n’envoie pas d’e-mails d’invitation. Les lecteurs importés configurent leur compte avec Forgot password sur la page de connexion, ou se connectent avec un code si vous avez activé les codes de connexion.

​
Limiter la durée d’accès d’un lecteur

Définissez Access until lorsque vous invitez ou importez un lecteur. Après cette date, le lecteur ne peut plus se connecter et sa session en cours prend fin.

​
Supprimer un lecteur

Ouvrez le menu d’actions sur la ligne du lecteur et cliquez sur Remove reader. Mintlify déconnecte le lecteur lors du prochain rafraîchissement de sa session, et il ne peut plus se connecter à moins que vous ne l’invitiez de nouveau.

​
Comment les lecteurs se connectent

Lorsqu’une personne visite votre site, elle voit une page de connexion avec votre logo. Selon les méthodes que vous avez activées, elle peut :
  • Saisir son adresse e-mail et son mot de passe.
  • Cliquer sur Email me a code et saisir le code à 6 chiffres reçu par e-mail. Les codes expirent au bout de 10 minutes.
  • Cliquer sur Forgot password? pour recevoir un lien de réinitialisation. Les liens de réinitialisation expirent au bout d’une heure et ne fonctionnent qu’une fois.
Un lecteur saisit jordan@acme.com sur la page de connexion de la documentation Acme, clique sur Email me a code et voit une invite à saisir le code à 6 chiffres reçu par e-mail.
Les mots de passe doivent comporter au moins 12 caractères. Après 10 tentatives de mot de passe infructueuses, le compte est verrouillé pendant 15 minutes. Les sessions durent sept jours, ou jusqu’à la date Access until du lecteur si celle-ci arrive en premier. La page de connexion ne révèle jamais si une adresse e-mail a accès. Une personne qui saisit une adresse qui n’appartient pas à un lecteur voit le même message “Check your email”, et aucun e-mail n’est envoyé.

​
Contrôler l’accès avec des groupes

Les groupes déterminent les pages que chaque lecteur peut voir. Ils fonctionnent de la même manière que les groupes de l’authentification OAuth et JWT :
  • Les pages sans propriété groups sont visibles par tous les lecteurs connectés.
  • Les pages avec une propriété groups ne sont visibles que par les lecteurs appartenant à au moins un de ces groupes.
  • Les pages avec public: true sont visibles par tout le monde, y compris les visiteurs non connectés.
Page for the partners group
Les lecteurs obtiennent des groupes de deux façons :
  • Par lecteur : définissez des groupes lorsque vous invitez ou importez un lecteur.
  • Règles de domaine : attribuez les mêmes groupes à tous les lecteurs dont le domaine d’e-mail correspond. Saisissez une règle par ligne : le domaine, puis les groupes séparés par des espaces.
Domain rules
Par exemple, une règle pour acme.com correspond à dana@acme.com. Une règle pour *.acme-partners.com correspond aux sous-domaines tels que sam@eu.acme-partners.com, mais pas à acme-partners.com lui-même. Les règles de domaine ne font qu’ajouter des groupes. Les personnes dont le domaine correspond ont toujours besoin d’une invitation pour se connecter.

​
Envoyer les e-mails destinés aux lecteurs depuis votre propre domaine

Par défaut, les e-mails destinés aux lecteurs sont envoyés depuis notifications@mintlify.com avec votre From name. Pour les envoyer depuis votre propre adresse, par exemple docs@docs.acme.com, ajoutez un domaine d’envoi.
1

Ajoutez votre domaine.

  1. Dans vos paramètres Access, repérez Sending domain dans les paramètres Emails.
  2. Saisissez le nom de l’expéditeur, par exemple docs, et le domaine, par exemple docs.acme.com.
  3. Cliquez sur Add domain.
Utilisez un sous-domaine depuis lequel vous n’envoyez pas encore d’e-mails, afin que ces enregistrements n’affectent pas votre configuration de messagerie existante.
2

Ajoutez les enregistrements DNS.

Copiez chaque enregistrement chez votre fournisseur DNS. Mintlify affiche un enregistrement DKIM TXT ainsi que des enregistrements SPF MX et TXT sur le sous-domaine send de votre domaine.
3

Vérifiez.

Une fois les enregistrements propagés, cliquez sur Verify. Lorsque le statut passe à Verified, les e-mails destinés aux lecteurs sont envoyés depuis votre adresse.
Tant que votre domaine n’est pas vérifié, les e-mails destinés aux lecteurs continuent d’être envoyés depuis notifications@mintlify.com. Chaque site peut avoir un seul domaine d’envoi, et chaque domaine ne peut appartenir qu’à un seul site. Vous ne pouvez pas utiliser mintlify.com ni ses sous-domaines. Pour modifier le nom de l’expéditeur, modifiez-le puis enregistrez. Pour arrêter l’envoi depuis votre domaine, cliquez sur Remove.