Skip to content

Commit 61f551c

Browse files
Documentation edits made through Mintlify web editor
1 parent 60e5efb commit 61f551c

File tree

6 files changed

+14
-16
lines changed

6 files changed

+14
-16
lines changed

settings/authentication-personalization/authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Authentication is similar to our [Personalization](./personalization) offering,
2828
to securing your documentation content, all features that are available via
2929
Personalization are also available via Authentication.
3030

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

settings/authentication-personalization/partial-authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ By default, all pages are protected. You can specify which pages should be publi
2222
title: "My Page"
2323
public: true
2424
---
25-
```
25+
```

settings/authentication-personalization/personalization-setup/oauth.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ If you have an existing OAuth server that supports the PKCE flow, you can integr
3333

3434
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`.
3535

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 Mintlifys 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.
3737

3838
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:
3939
- **Authorization URL**: `https://auth.foo.com/authorization`
@@ -42,4 +42,4 @@ I then go to the dashboard settings, navigate to the Personalization settings, s
4242
- **Token URL**: `https://auth.foo.com/exchange`
4343
- **Info API URL**: `https://api.foo.com/docs/user-info`
4444

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.

settings/authentication-personalization/personalization-setup/shared-session.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: 'Seamlessly share user sessions between your dashboard and your doc
77
This is the documentation for the Shared Session **Personalization** Handshake. The Shared Session Handshake is not available for Authentication.
88
</Info>
99

10-
This method utilizes the session authentication info already stored in your users 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.
1111

1212
## Implementation
1313

@@ -17,7 +17,7 @@ This method utilizes the session authentication info already stored in your user
1717

1818
If the API domain does not *exactly match* the docs domain:
1919
- Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`)
20-
- Ensure your APIs `Access-Control-Allow-Credentials` header is `true`
20+
- Ensure your API's `Access-Control-Allow-Credentials` header is `true`
2121
<Warning>
2222
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.
2323
</Warning>
@@ -33,22 +33,22 @@ This method utilizes the session authentication info already stored in your user
3333

3434
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`.
3535

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 Mintlifys 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**.
3737

3838
I then go to the dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
3939

4040
### Dashboard at subdomain, docs at root
4141

4242
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`.
4343

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 Mintlifys 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**.
4545

4646
I then go to the dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
4747

4848
### Dashboard at root, docs at root
4949

5050
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`.
5151

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 Mintlifys 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.
5353

5454
I then go to the dashboard settings and enter `https://foo.com/api/docs/user-info` for the API URL field.

settings/authentication-personalization/personalization.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This feature becomes even more powerful when paired with custom data about the u
3030
3131
Personalization is an enterprise feature. {
3232
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.</>
3434
: user.org.plan !== 'enterprise'
3535
? <>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>.</>
3636
: <>To request this feature for your enterprise org, <a href="mailto:[email protected]">contact our team</a>.</>
@@ -39,7 +39,7 @@ user.org === undefined
3939
```jsx
4040
Personalization is an enterprise feature. {
4141
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.</>
4343
: user.org.plan !== 'enterprise'
4444
? <>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>.</>
4545
: <>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
8282
<Note>
8383
Note that an empty array in the page metadata is interpreted as "No groups
8484
should see this page."
85-
</Note>
85+
</Note>

settings/authentication-personalization/sending-data.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ type User = {
3131
path="groups"
3232
type="string[]"
3333
>
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 pages 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.
3535
</ParamField>
3636
<ParamField
3737
path="content"
@@ -46,6 +46,4 @@ type User = {
4646
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.
4747

4848
<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>
49-
</ParamField>
50-
51-
49+
</ParamField>

0 commit comments

Comments
 (0)