This is the documentation for Authentication Handshake methods. Personalization offers a different set of Handshake methods.
- Password: Configure a set of global passwords for your documentation site.
- JWT: Use your own login flow to authenticate your users via a JWT in the URL.
- OAuth 2.0: Integrate with your OAuth server to enable user login via the standard Authorization Code flow.
- Mintlify Dashboard: Allow all of your dashboard users to access your docs, zero configuration required.
Prerequisites
- Password
- JWT
- OAuth 2.0
- Mintlify Dashboard
- Your security requirements allow for password sharing between documentation readers.
Pros & Cons
- Password
- JWT
- OAuth 2.0
- Mintlify Dashboard
Pros:
- Super simple setup
- No configuration required for adding new users - just share the password
- 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