Skip to content

Commit d3cce10

Browse files
committed
adjust personalization handshake methods
1 parent 1862050 commit d3cce10

File tree

6 files changed

+28
-99
lines changed

6 files changed

+28
-99
lines changed

advanced/user-auth/overview.mdx

Lines changed: 0 additions & 88 deletions
This file was deleted.

advanced/user-auth/choosing-an-auth-method.mdx renamed to settings/authentication-personalization/personalization/choosing-a-handshake.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
---
2-
title: 'Choosing an Auth Method'
2+
title: 'Choosing a Handshake'
33
description: 'How to decide which auth method is right for your docs'
44
---
55

6-
Before your users can access personalized content, they must be authenticated. Mintlify supports three methods of authenticating users:
6+
<Info>
7+
This is the documentation for **Personalization** Handshake methods. Authentication offers a [different set of Handshake methods](/settings/authentication-personalization/authentication/choosing-a-handshake).
8+
</Info>
9+
10+
Before your users can access personalized content, they must be authenticated. Mintlify supports three Personalization Handshake methods:
711

812
1. **Shared Session**: Utilize the same session token used by your dashboard to authenticate users.
913
2. **JWT**: Use your own login flow to send user info to your docs via a JWT in the URL.

advanced/user-auth/jwt.mdx renamed to settings/authentication-personalization/personalization/jwt.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,28 @@ title: 'JWT Auth'
33
description: 'Use a customized login flow to authenticate users'
44
---
55

6+
<Info>
7+
This is the documentation for the JWT **Personalization** Handshake. The steps for setting up the [JWT **Authentication** Handshake](/settings/authentication-personalization/authentication/jwt) are slightly different.
8+
</Info>
9+
10+
611
If you don’t have a dashboard, or if you want to keep your dashboard and docs completely separate, you can use your own login flow to send user info to your docs via a JWT in the URL.
712

813
## Implementation
914

1015
<Steps>
1116
<Step title="Generate a private key">
12-
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication) and generate a private key. Store this key somewhere secure where it can be accessed by your backend.
17+
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/products/authentication) and generate a private key. Store this key somewhere secure where it can be accessed by your backend.
1318
</Step>
1419
<Step title="Create a login flow">
1520
Create a login flow that does the following:
1621
- Authenticate the user
17-
- Create a JWT containing the authenticated user's info in the [UserInfo](./sending-data) format
22+
- Create a JWT containing the authenticated user's info in the [UserInfo](../sending-data) format
1823
- Sign the JWT with the secret, using the EdDSA algorithm
1924
- Create a redirect URL back to your docs, including the JWT as the hash
2025
</Step>
2126
<Step title="Configure your User Auth settings">
22-
Return to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication) and add the login URL to your User Auth settings.
27+
Return to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/products/authentication) and add the login URL to your User Auth settings.
2328
</Step>
2429
</Steps>
2530

advanced/user-auth/oauth.mdx renamed to settings/authentication-personalization/personalization/oauth.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,20 @@ title: 'OAuth 2.0'
33
description: 'Integrate with your OAuth server to enable user login via the PKCE flow'
44
---
55

6+
<Info>
7+
This is the documentation for the OAuth **Personalization** Handshake. The steps for setting up the [OAuth **Authentication** Handshake](/settings/authentication-personalization/authentication/oauth) are slightly different.
8+
</Info>
9+
610
If you have an existing OAuth server that supports the PKCE flow, you can integrate with Mintlify for a seamless login experience.
711

812
## Implementation
913

1014
<Steps>
1115
<Step title="Create your Info API">
12-
Create an API endpoint that can be accessed with an OAuth access token, and responds with a JSON payload following the [UserInfo](./sending-data) format. Take note of the scope or scopes required to access this endpoint.
16+
Create an API endpoint that can be accessed with an OAuth access token, and responds with a JSON payload following the [UserInfo](../sending-data) format. Take note of the scope or scopes required to access this endpoint.
1317
</Step>
1418
<Step title="Configure your User Auth settings">
15-
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication), select the OAuth option, and fill out the required fields:
19+
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/products/authentication), select the OAuth option, and fill out the required fields:
1620

1721
- **Authorization URL**: The base URL for the authorization request, to which we will add the appropriate query parameters.
1822
- **Client ID**: An ID for the OAuth 2.0 client to be used.
@@ -21,7 +25,7 @@ If you have an existing OAuth server that supports the PKCE flow, you can integr
2125
- **Info API URL**: The endpoint that will be hit to retrieve user info.
2226
</Step>
2327
<Step title="Configure your OAuth client">
24-
Copy the Redirect URL listed in the [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication) and add it as an authorized redirect URL for your OAuth server.
28+
Copy the Redirect URL listed in the [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/products/authentication) and add it as an authorized redirect URL for your OAuth server.
2529
</Step>
2630
</Steps>
2731

advanced/user-auth/shared-session.mdx renamed to settings/authentication-personalization/personalization/shared-session.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@ title: 'Shared Session Auth'
33
description: 'Seamlessly share user sessions between your dashboard and your docs'
44
---
55

6+
<Info>
7+
This is the documentation for the Shared Session **Personalization** Handshake. The Shared Session Handshake is not available for Authentication.
8+
</Info>
9+
610
This method utilizes the session authentication info already stored in your user’s browser to create a seamless documentation experience.
711

812
## Implementation
913

1014
<Steps>
1115
<Step title="Create your Info API">
12-
Create an API endpoint that uses session authentication to identify users, and responds with a JSON payload following the [UserInfo](./sending-data) format.
16+
Create an API endpoint that uses session authentication to identify users, and responds with a JSON payload following the [UserInfo](../sending-data) format.
1317

1418
If the API domain does not *exactly match* the docs domain:
1519
- Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`)
@@ -19,7 +23,7 @@ This method utilizes the session authentication info already stored in your user
1923
</Warning>
2024
</Step>
2125
<Step title="Configure your User Auth settings">
22-
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication) and add the API URL and your Login URL to your User Auth settings.
26+
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/products/authentication) and add the API URL and your Login URL to your User Auth settings.
2327
</Step>
2428
</Steps>
2529

settings/authentication-personalization/sending-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: 'Sending Data'
33
description: 'The types and shape of user data you can send to Mintlify'
44
---
55

6-
Depending on your authentication configuration, your API will respond with either a raw JSON object or a signed JWT. The shape of the data is the same for both:
6+
Depending on your Handshake method, your API will respond with either a raw JSON object or a signed JWT. The shape of the data is the same for both:
77

88
```tsx
99
type UserInfo = {

0 commit comments

Comments
 (0)