Skip to content

Commit e24acbe

Browse files
committed
add mintlify auth info
1 parent f9ff80a commit e24acbe

File tree

1 file changed

+30
-31
lines changed

1 file changed

+30
-31
lines changed

authentication-personalization/authentication-setup.mdx

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -157,58 +157,57 @@ When an unauthenticated user tries to access a protected page, their intended de
157157

158158
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.
159159

160-
To set up authentication with Mintlify, configure your OAuth server details in your dashboard:
160+
To set up authentication with Mintlify, **configure your OAuth server details** in your dashboard:
161161
- **Authorization URL**: `https://auth.foo.com/authorization`
162162
- **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH`
163163
- **Scopes**: `['docs-user-info']`
164164
- **Token URL**: `https://auth.foo.com/exchange`
165165
- **Info API URL**: `https://api.foo.com/docs/user-info`
166166

167+
**Create a user info endpoint** at `api.foo.com/docs/user-info`, which requires an OAuth access token with the `docs-user-info` scope, and returns:
167168

168-
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.
169-
170-
I then go to the dashboard settings, navigate to the Authentication settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint:
171-
169+
```json
170+
{
171+
"content": {
172+
"firstName": "Jane",
173+
"lastName": "Doe"
174+
},
175+
"groups": ["engineering", "admin"]
176+
}
177+
```
172178

173-
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.
179+
**Configure your OAuth server to allow redirects** to your callback URL.
174180
</Tab>
175181
<Tab title="Mintlify Dashboard">
176182
### Prerequisites
177183

178-
- Your documentation readers are also your documentation editors.
184+
* Your documentation users are also your documentation editors.
179185

180186
### Implementation
181187

182-
### Example
183-
184-
I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs
185-
to be internal, and the people that will be viewing my docs are the same people that
186-
contribute to my docs.
187-
188-
To set up authentication with Mintlify, I can go to my [dashboard settings](https://dashboard.mintlify.com/products/authentication)
189-
and enable Authentication with the Mintlify Auth Handshake.
190-
191-
I can then ensure that anyone that should be able to read the docs has been added as a user in
192-
my [dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
193-
194-
## Implementation
195-
196188
<Steps>
197-
<Step title="Configure your Authentication settings">
198-
Go to your [Mintlify dashboard
199-
settings](https://dashboard.mintlify.com/products/authentication) and select
200-
the Mintlify Auth Handshake.
189+
<Step title="Enable Mintlify dashboard authentication.">
190+
1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication).
191+
2. Select **Full Authentication** or **Partial Authentication**.
192+
3. Select **Mintlify Auth**.
193+
4. Select **Enable Mintlify Auth**.
201194
</Step>
202-
<Step title="Add users">
203-
Ensure that any users that should be able to view your documentation have
204-
been added as users in your [Mintlify dashboard
205-
settings](https://dashboard.mintlify.com/settings/organization/members).
195+
<Step title="Add authorized users.">
196+
1. In your dashboard, go to [Members](https://dashboard.mintlify.com/settings/organization/members).
197+
2. Add each person who should have access to your documentation.
198+
3. Assign appropriate roles based on their editing permissions.
206199
</Step>
207200
</Steps>
208201

202+
### Example
203+
204+
Your documentation is hosted at `docs.foo.com` and your team uses the dashboard to edit your docs. You want to restrict access to team members only.
209205

210-
</Tab>
211-
<Tab title="Password">
206+
**Enable Mintlify authentication** in your dashboard settings.
207+
208+
**Verify team access** by checking that all team members are added to your organization.
209+
</Tab>
210+
<Tab title="Password">
212211
<Info>
213212
Password authentication is used for access control only. Does not allow for personalizaiton.
214213
</Info>

0 commit comments

Comments
 (0)