Überblick

Steuern Sie, wer Ihre Dokumentation sieht, und passen Sie das Nutzungserlebnis an

Pro-Pläne enthalten Passwort-Authentifizierung.

Enterprise-Pläne enthalten alle Authentifizierungsmethoden.

Wählen Sie aus drei Ansätzen, um den Zugriff zu verwalten und Ihre Dokumentation basierend auf Nutzerinformationen und Ihren Sicherheitsanforderungen anzupassen:

• Vollständige Authentifizierung: Vollständiger Schutz der Privatsphäre für alle Inhalte mit umfassender Inhaltsanpassung.
• Partielle Authentifizierung: Seitenweises Zugriffsmanagement mit umfassender Inhaltsanpassung.
• Personalisierung: Inhaltsanpassung ohne Sicherheitsgarantien. Alle Inhalte bleiben öffentlich zugänglich.

Anwendungsbeispiele

Wählen Sie vollständige Authentifizierung, wenn:

• interne Unternehmensdokumentation mit sensiblen Informationen erstellt wird
• proprietäre APIs dokumentiert werden, die eine Benutzerverifizierung erfordern
• kundenspezifische Implementierungsleitfäden erstellt werden

Wählen Sie partielle Authentifizierung, wenn:

• öffentliche Einstiegsleitfäden mit privaten, erweiterten Funktionen angeboten werden
• ein Freemium-Produkt betrieben wird, bei dem Premium-Nutzer zusätzliche Dokumentation erhalten
• Open-Source-Dokumentation mit privaten Enterprise-Bereichen veröffentlicht wird

Wählen Sie Personalisierung, wenn:

• öffentliche API-Dokumentation erstellt wird, die nutzerspezifische Beispiele zeigt
• Marketingseiten erstellt werden, die Inhalte basierend auf Nutzerprofilen anpassen
• öffentliche Tutorials angeboten werden, die sich an Nutzerpräferenzen oder Kenntnisstände anpassen

Handshake-Methoden

Wählen Sie die Methode, die am besten zu Ihrer bestehenden Infrastruktur und Ihren Sicherheitsanforderungen passt.

Methode	Verfügbar für	Einrichtungsaufwand	Am besten geeignet für
JWT	Alle Ansätze	Mittel	Benutzerdefinierte Login-Flows, maximale Kontrolle über die Sicherheit
OAuth 2.0	Alle Ansätze	Hoch	Auth-Provider von Drittanbietern, Enterprise-Sicherheit
Mintlify Dashboard	Nur Authentifizierung	Niedrig	Teams, die bereits das Mintlify-Dashboard nutzen
Passwort	Nur Authentifizierung	Niedrig	Einfacher gemeinsamer Zugriff ohne Personalisierung
Geteilte Sitzung	Nur Personalisierung	Niedrig	Apps mit bestehender sitzungsbasierter Authentifizierung

Wann welche Methode verwenden

JWT: Verwenden Sie diese Methode, wenn Sie ein bestehendes Authentifizierungssystem haben und die volle Kontrolle über den Anmeldeablauf behalten möchten. Ideal für maßgeschneidertes Benutzer-Management oder wenn Sie den Dokumentationszugriff von Ihrer Hauptanwendung entkoppeln müssen.

OAuth 2.0: Verwenden Sie diese Methode, wenn Sie Drittanbieter wie Google oder GitHub einbinden möchten oder Sicherheitsstandards auf Enterprise-Niveau benötigen. Am besten geeignet für Organisationen, die bereits eine OAuth-Infrastruktur nutzen.

Mintlify Dashboard: Verwenden Sie diese Methode, wenn Ihre Dokumentations-Redakteure zugleich die Leser sind. Perfekt für interne Teams, die Inhalte bereits über das Mintlify-Dashboard verwalten.

Passwort: Verwenden Sie diese Methode für einfache Zugriffskontrolle, wenn Sie keine einzelnen Nutzer nachverfolgen oder Inhalte personalisieren müssen. Geeignet für Auftragnehmer, Beta-Nutzer oder temporäre Zugriffsszenarien.

Gemeinsame Sitzung: Verwenden Sie diese Methode, wenn Sie eine nahtlose Anmeldung zwischen Ihrer Anwendung und der Dokumentation wünschen. Ideal, wenn Nutzer bereits in Ihrer Hauptanwendung angemeldet sind und Sie ihre Dokumentationserfahrung personalisieren möchten.

Inhaltsanpassung

Alle drei Ansätze unterstützen Funktionen zur Personalisierung von Inhalten, einschließlich dynamischer MDX-Inhalte, dem Vorausfüllen von API-Schlüsseln und der Steuerung der Seitensichtbarkeit. Ausführliche Implementierungshinweise finden Sie unter Einrichtung der Personalisierung.