This is the documentation for Authentication Handshake methods. Personalization offers a different set of Handshake methods.

Before your users can access personalized content, they must be authenticated. Mintlify supports four Authentication Handshake methods:

  1. Password: Configure a set of global passwords for your documentation site.
  2. JWT: Use your own login flow to authenticate your users via a JWT in the URL.
  3. OAuth 2.0: Integrate with your OAuth server to enable user login via the standard Authorization Code flow.
  4. Mintlify Dashboard: Allow all of your dashboard users to access your docs, zero configuration required.

​
Prerequisites

  • Your security requirements allow for password sharing between documentation readers.

​
Pros & Cons

Pros:

  • Super simple setup
  • No configuration required for adding new users - just share the password

Cons:

  • Difficult to revoke access to your docs without resetting the password
  • Lose personalization features, as there is no way to differentiate users with the same password

Was this page helpful?

Auth vs PersonalizationPassword Handshake