Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,35 +1,44 @@
---
title: 'Mintlify Dashboard Handshake'
description: 'Use the Mintlify Dashboard to authenticate users'
description: 'Use Mintlify to authenticate users'
---

<Note>
Mintlify Dashboard Handshake is available only by request. Please <a href="mailto:[email protected]">contact our sales team</a> for access. After we've enabled access, you can follow the implementation instructions.
</Note>


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit misleading - you do not need to use the dashboard handshake for your main handshake method to use it for your preview deployments. Maybe something like this?

"This handshake method can also be used to protect preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments. You can enable private preview deployments regardless of the type of authentication used for your docs"

or something like that

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed - it is 2 different toggles in the UI and 2 different features.


<Info>
This is the documentation for the Mintlify Dashboard **Authentication** Handshake. The Mintlify Dashboard Handshake is not available for Personalization.
The Mintlify Dashboard Handshake is available only for Authentication, *not* Personalization.
</Info>

If your documentation readers are also your documentation editors, you can allow Mintlify to manage access to your documentation. Anyone that can access
your dashboard will automatically be able to access your documentation.
### 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 [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication)
and enable Authentication with the Mintlify Dashboard Handshake.

I can then ensure that anyone that should be able to read the docs has been added as a user in
my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).

## Implementation

<Steps>
<Step title="Configure your Authentication settings">
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and enable the Mintlify Dashboard Handshake.
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and select the Mintlify Auth Handshake.
</Step>
<Step title="Add users">
Ensure that any users that should be able to view your documentation have been added as users in your
[Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
</Step>
</Steps>

## 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 go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication)
and enable Authentication with the Mintlify Dashboard Handshake.

I then ensure that anyone that should be able to read the docs has been added as a user in
my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
21 changes: 15 additions & 6 deletions settings/authentication-personalization/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
---
title: 'Authentication'
description: 'Features available with the Authentication product'
description: 'Guarantee privacy of your docs by authenticating users'
---

<Note>
Authentication is an enterprise feature. To get access, [contact sales](mailto:[email protected]).
</Note>

As the name suggests, Authentication offers full privacy for all of your
documentation content. This includes all of the following:
Authentication offers full privacy for all of your
documentation content by requiring users to authenticate before viewing any content, such as:

- Documentation page content
- Images used in documentation pages
- Search results
- AI chat interactions

Authentication can be thought of as Personalization + privacy. In addition
You can authenticate users through handshake methods such as:

- [Password](./authentication-setup/password)
- [JWT](./authentication-setup/jwt)
- [OAuth](./authentication-setup/oauth)
- [Mintlify dashboard](./authentication-setup/mintlify)


Authentication is similar to our [Personalization](./personalization) offering, but with guaranteed privacy. In addition
to securing your documentation content, all features that are available via
Personalization are also available via Authentication. For more information
about the features of Personalization, [visit our docs on Personalization](./personalization).
Personalization are also available via Authentication.

Check out our docs for more info on [choosing Authentication vs Personalization]((./authentication-vs-personalization)).
Loading