You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: authentication-personalization/authentication-setup.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ Select the handshake method that you want to configure.
47
47
48
48
Your documentation is hosted at `docs.foo.com` with an existing authentication system at `foo.com`. You want to extend your login flow to grant access to the docs while keeping your docs separate from your dashboard (or you don't have a dashboard).
49
49
50
-
To do this, create a login endpoint at `https://foo.com/docs-login` that extends your existing authentication.
50
+
Create a login endpoint at `https://foo.com/docs-login` that extends your existing authentication.
51
51
52
52
After verifying user credentials:
53
53
* Generate a JWT with user data in Mintlify's format.
@@ -153,7 +153,7 @@ When an unauthenticated user tries to access a protected page, their intended de
153
153
</Step>
154
154
</Steps>
155
155
156
-
## Example
156
+
###Example
157
157
158
158
Your documentation is hosted at `foo.com/docs` and you have an existing OAuth server at `auth.foo.com` that supports the Authorization Code Flow.
159
159
@@ -214,7 +214,7 @@ Password authentication provides access control only and does **not** support co
214
214
215
215
### Prerequisites
216
216
217
-
* Your security requirements allow password sharing among your users.
217
+
* Your security requirements allow sharing passwords among users.
Copy file name to clipboardExpand all lines: authentication-personalization/partial-authentication-setup.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ Partial authentication shares all the same features as authentication, but with
10
10
11
11
## Setup
12
12
13
-
Follow the [Authentication setup](/authentication-personalization/authentication-setup) guide and select **Partial Authentication** when configuring your chosen handshake method.
13
+
Follow the [Authentication Setup](/authentication-personalization/authentication-setup) guide and select **Partial Authentication** when configuring your chosen handshake method.
14
14
15
15
## Making pages public
16
16
17
-
By default, all pages are protected. Add the `public` property to the page's frontmatter to make it viewable without authentication.
17
+
By default, all pages are protected. Add the `public` property to the page's frontmatter to make it viewable without authentication:
***Info API URL**: `https://api.foo.com/docs/user-info`
140
140
141
141
**Configure your OAuth server** to allow redirects to your callback URL.
142
142
</Tab>
@@ -159,21 +159,20 @@ Your documentation is hosted at `foo.com/docs` and you have an existing OAuth se
159
159
* Uses your existing session authentication to identify users
160
160
* Returns user data in the `User` format (see [Sending Data](/authentication-personalization/sending-data))
161
161
* If the API domain and the docs domain **do not exactly match**:
162
-
- Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`).
163
-
- Set your API's `Access-Control-Allow-Credentials` header to `true`.
162
+
* Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`).
163
+
* Set your API's `Access-Control-Allow-Credentials` header to `true`.
164
164
165
165
<Warning>
166
166
Only enable CORS headers on this specific endpoint, not your entire dashboard API.
167
167
</Warning>
168
168
</Step>
169
169
<Steptitle="Configure your personalization settings">
170
-
Go to your [dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the API URL and your Login URL to your Personalization settings.
171
170
1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication).
172
171
2. Select **Personalization**.
173
172
3. Select **Shared Session**.
174
173
4. Enter your **Info API URL**, which is the endpoint from the first step.
175
-
5. Enter your **Login URL**, where users log in to your dashboard.
176
-
6. Select **Save changes**
174
+
5. Enter your **Login URL**, where users log into your dashboard.
175
+
6. Select **Save changes**.
177
176
</Step>
178
177
</Steps>
179
178
@@ -190,18 +189,18 @@ You have a dashboard at `dash.foo.com`, which uses cookie-based session authenti
190
189
*`Access-Control-Allow-Credentials`: `true`
191
190
3.**Configure API URL** in authentication settings: `https://dash.foo.com/api/docs/user-info`.
192
191
193
-
### Dashboard at subdomain, docs at root
192
+
####Dashboard at subdomain, docs at root
194
193
195
194
You have a dashboard at `dash.foo.com`, which uses cookie-based session authentication. Your dashboard API routes are hosted at `dash.foo.com/api`. You want to set up personalization for your docs hosted at `foo.com/docs`.
196
195
197
196
**Setup process**:
198
197
1.**Create endpoint**`dash.foo.com/api/docs/user-info` that identifies users via session authentication and responds with their user data.
199
198
2.**Add CORS headers** for this route only:
200
-
-`Access-Control-Allow-Origin`: `https://foo.com`
201
-
-`Access-Control-Allow-Credentials`: `true`
199
+
*`Access-Control-Allow-Origin`: `https://foo.com`
200
+
*`Access-Control-Allow-Credentials`: `true`
202
201
3.**Configure API URL** in authentication settings: `https://dash.foo.com/api/docs/user-info`.
203
202
204
-
### Dashboard at root, docs at root
203
+
####Dashboard at root, docs at root
205
204
206
205
You have a dashboard at `foo.com/dashboard`, which uses cookie-based session authentication. Your dashboard API routes are hosted at `foo.com/api`. You want to set up personalization for your docs hosted at `foo.com/docs`.
0 commit comments