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: settings/authentication-personalization/personalization-setup/oauth.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
@@ -33,7 +33,7 @@ If you have an existing OAuth server that supports the PKCE flow, you can integr
33
33
34
34
I have an existing OAuth server that supports the PKCE flow. I want to set up authentication for my docs hosted at `foo.com/docs`.
35
35
36
-
To set up authentication with Mintlify, I create an endpoint `api.foo.com/docs/user-info` which requires an OAuth access token with the `docs-user-info` scope, and responds with the user's custom data according to Mintlify’s specification.
36
+
To set up authentication with Mintlify, I create an endpoint `api.foo.com/docs/user-info` which requires an OAuth access token with the `docs-user-info` scope, and responds with the user's custom data according to Mintlify's specification.
37
37
38
38
I then go to the dashboard settings, navigate to the Personalization settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint:
@@ -42,4 +42,4 @@ I then go to the dashboard settings, navigate to the Personalization settings, s
42
42
-**Token URL**: `https://auth.foo.com/exchange`
43
43
-**Info API URL**: `https://api.foo.com/docs/user-info`
44
44
45
-
Finally, I copy the Redirect URL displayed in the dashboard settings and add it as an authorized redirect URL in my OAuth client configuration settings.
45
+
Finally, I copy the Redirect URL displayed in the dashboard settings and add it as an authorized redirect URL in my OAuth client configuration settings.
Copy file name to clipboardExpand all lines: settings/authentication-personalization/personalization-setup/shared-session.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ description: 'Seamlessly share user sessions between your dashboard and your doc
7
7
This is the documentation for the Shared Session **Personalization** Handshake. The Shared Session Handshake is not available for Authentication.
8
8
</Info>
9
9
10
-
This method utilizes the session authentication info already stored in your user’s browser to create a seamless documentation experience.
10
+
This method utilizes the session authentication info already stored in your user's browser to create a seamless documentation experience.
11
11
12
12
## Implementation
13
13
@@ -17,7 +17,7 @@ This method utilizes the session authentication info already stored in your user
17
17
18
18
If the API domain does not *exactly match* the docs domain:
19
19
- Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`)
20
-
- Ensure your API’s `Access-Control-Allow-Credentials` header is `true`
20
+
- Ensure your API's `Access-Control-Allow-Credentials` header is `true`
21
21
<Warning>
22
22
These CORS options only need to be enabled on the *single endpoint* responsible for returning user information. We do not recommend enabling these options on all dashboard endpoints.
23
23
</Warning>
@@ -33,22 +33,22 @@ This method utilizes the session authentication info already stored in your user
33
33
34
34
I have a dashboard at `dash.foo.com`, which uses cookie-based session authentication. My dashboard API routes are hosted at `dash.foo.com/api`. I want to set up authentication for my docs hosted at `docs.foo.com`.
35
35
36
-
To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add `https://docs.foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true`**for this route only**.
36
+
To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify's specification. I then add `https://docs.foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true`**for this route only**.
37
37
38
38
I then go to the dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
39
39
40
40
### Dashboard at subdomain, docs at root
41
41
42
42
I have a dashboard at `dash.foo.com`, which uses cookie-based session authentication. My dashboard API routes are hosted at `dash.foo.com/api`. I want to set up authentication for my docs hosted at `foo.com/docs`.
43
43
44
-
To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add `https://foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true`**for this route only**.
44
+
To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify's specification. I then add `https://foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true`**for this route only**.
45
45
46
46
I then go to the dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
47
47
48
48
### Dashboard at root, docs at root
49
49
50
50
I have a dashboard at `foo.com/dashboard`, which uses cookie-based session authentication. My dashboard API routes are hosted at `foo.com/api`. I want to set up authentication for my docs hosted at `foo.com/docs`.
51
51
52
-
To set up authentication with Mintlify, I create another dashboard endpoint `foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification.
52
+
To set up authentication with Mintlify, I create another dashboard endpoint `foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify's specification.
53
53
54
54
I then go to the dashboard settings and enter `https://foo.com/api/docs/user-info` for the API URL field.
Copy file name to clipboardExpand all lines: settings/authentication-personalization/personalization.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
@@ -30,7 +30,7 @@ This feature becomes even more powerful when paired with custom data about the u
30
30
31
31
Personalization is an enterprise feature. {
32
32
user.org === undefined
33
-
? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
33
+
? <>To access this feature, first create an account.</>
34
34
: user.org.plan !== 'enterprise'
35
35
? <>You are currently on the ${user.org.plan??'free'} plan. To speak to our team about upgrading, <a href="mailto:[email protected]">contact our sales team</a>.</>
36
36
:<>To request this feature for your enterprise org, <a href="mailto:[email protected]">contact our team</a>.</>
@@ -39,7 +39,7 @@ user.org === undefined
39
39
```jsx
40
40
Personalization is an enterprise feature. {
41
41
user.org === undefined
42
-
? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
42
+
? <>To access this feature, first create an account.</>
43
43
: user.org.plan !== 'enterprise'
44
44
? <>You are currently on the ${user.org.plan??'free'} plan. To speak to our team about upgrading, <a href="mailto:[email protected]">contact our sales team</a>.</>
45
45
:<>To request this feature for your enterprise org, <a href="mailto:[email protected]">contact our team</a>.</>
@@ -82,4 +82,4 @@ Here's a table that displays whether a page is shown for different combinations
82
82
<Note>
83
83
Note that an empty array in the page metadata is interpreted as "No groups
Copy file name to clipboardExpand all lines: settings/authentication-personalization/sending-data.mdx
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ type User = {
31
31
path="groups"
32
32
type="string[]"
33
33
>
34
-
A list of groups that the user belongs to. This will determine which pages should be shown to this user. If any of these groups is listed in the `groups` field of a page’s metadata, that page will be shown.
34
+
A list of groups that the user belongs to. This will determine which pages should be shown to this user. If any of these groups is listed in the `groups` field of a page's metadata, that page will be shown.
35
35
</ParamField>
36
36
<ParamField
37
37
path="content"
@@ -46,6 +46,4 @@ type User = {
46
46
User-specific values that will be prefilled in the API playground if supplied. For example, if each of my customers makes requests at a specific subdomain, I can send `{ server: { subdomain: 'foo' } }` as my `apiPlaygroundInputs` field, and this value will be prefilled on any API page with this `subdomain` value.
47
47
48
48
<Note>The`header`, `query`, and `cookie` fields will only be prefilled if they are part of your [security scheme](https://swagger.io/docs/specification/authentication/). Creating a standard header parameter named `Authorization` is not sufficient to enable this feature. To know if a field will be prefilled, navigate to your existing docs and check if the field is in either the `Authorization` or `Server` section.</Note>
0 commit comments