|
1 | 1 | ---
|
2 |
| -title: 'Mintlify Dashboard Handshake' |
3 |
| -description: 'Use the Mintlify Dashboard to authenticate users' |
| 2 | +title: "Mintlify Dashboard Handshake" |
| 3 | +description: "Use Mintlify to authenticate users" |
4 | 4 | ---
|
5 | 5 |
|
6 | 6 | <Info>
|
7 |
| - This is the documentation for the Mintlify Dashboard **Authentication** Handshake. The Mintlify Dashboard Handshake is not available for Personalization. |
| 7 | + The Mintlify Dashboard Handshake is available only for Authentication, *not* |
| 8 | + Personalization. |
8 | 9 | </Info>
|
9 | 10 |
|
10 |
| -If your documentation readers are also your documentation editors, you can allow Mintlify to manage access to your documentation. Anyone that can access |
11 |
| -your dashboard will automatically be able to access your documentation. |
| 11 | +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. |
12 | 12 |
|
13 |
| -## Implementation |
| 13 | +This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments. |
14 | 14 |
|
15 |
| -<Steps> |
16 |
| - <Step title="Configure your Authentication settings"> |
17 |
| - Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and enable the Mintlify Dashboard Handshake. |
18 |
| - </Step> |
19 |
| - <Step title="Add users"> |
20 |
| - Ensure that any users that should be able to view your documentation have been added as users in your |
21 |
| - [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members). |
22 |
| - </Step> |
23 |
| -</Steps> |
| 15 | +<Note> |
| 16 | + Authentication is available only by request. Please{" "} |
| 17 | + < a href="mailto:[email protected]">contact sales</ a> for access. After we've |
| 18 | + enabled access, you can follow the implementation instructions. |
| 19 | +</Note> |
24 | 20 |
|
25 |
| -## Example |
| 21 | +### Example |
26 | 22 |
|
27 | 23 | I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs
|
28 | 24 | to be internal, and the people that will be viewing my docs are the same people that
|
29 | 25 | contribute to my docs.
|
30 | 26 |
|
31 |
| -To set up authentication with Mintlify, I go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) |
| 27 | +To set up authentication with Mintlify, I can go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) |
32 | 28 | and enable Authentication with the Mintlify Dashboard Handshake.
|
33 | 29 |
|
34 |
| -I then ensure that anyone that should be able to read the docs has been added as a user in |
| 30 | +I can then ensure that anyone that should be able to read the docs has been added as a user in |
35 | 31 | my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
|
| 32 | + |
| 33 | +## Implementation |
| 34 | + |
| 35 | +<Steps> |
| 36 | + <Step title="Configure your Authentication settings"> |
| 37 | + Go to your [Mintlify dashboard |
| 38 | + settings](https://dashboard.mintlify.com/products/authentication) and select |
| 39 | + the Mintlify Auth Handshake. |
| 40 | + </Step> |
| 41 | + <Step title="Add users"> |
| 42 | + Ensure that any users that should be able to view your documentation have |
| 43 | + been added as users in your [Mintlify dashboard |
| 44 | + settings](https://dashboard.mintlify.com/settings/organization/members). |
| 45 | + </Step> |
| 46 | +</Steps> |
0 commit comments