Mintlify Auth Handshake

Use Mintlify to authenticate users

The Mintlify Auth Handshake is available only for Authentication, not Personalization.

You can use Mintlify to authenticate and manage access to your documentation. Anyone that can access your dashboard will automatically be able to see your documentation.

This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments.

Authentication is available only by request. Please contact sales for access. After we’ve enabled access, you can follow the implementation instructions.

Example

I want to set up authentication for my docs hosted at docs.foo.com. I want my docs to be internal, and the people that will be viewing my docs are the same people that contribute to my docs.

To set up authentication with Mintlify, I can go to my dashboard settings and enable Authentication with the Mintlify Auth Handshake.

I can then ensure that anyone that should be able to read the docs has been added as a user in my dashboard settings.

Implementation

1. Configure your Authentication settings

   Go to your Mintlify dashboard settings and select the Mintlify Auth Handshake.

2. Add users

   Ensure that any users that should be able to view your documentation have been added as users in your Mintlify dashboard settings.