Authentication Setup
Choosing a Handshake
Authentication Setup
Choosing a Handshake
How to decide which Handshake method is right for your docs
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:
- 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
- Your security requirements allow for password sharing between documentation readers.
- Your security requirements allow for password sharing between documentation readers.
- You have some existing login flow.
- You can add a final step in this login flow that creates a JWT and redirects to the docs.
- You have an existing OAuth server that supports the Authorization Code flow.
- You can create a new API endpoint that can be accessed by the returned OAuth access token.
- Your documentation readers are also your documentation editors.
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
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
Pros:
- Reduced risk of API endpoint abuse
- Zero CORS configuration
- No restrictions on API URLs
Cons:
- Must be able to hook into your existing login flow
Pros:
- Heightened security standard
Cons:
- Requires significant work if setting up OAuth server for the first time
- Might be overkill for some applications
Pros:
- Zero-config setup
Cons:
- Requires all docs readers to have an account in your Mintlify dashboard
Was this page helpful?