Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions advanced/dashboard/sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
---

<Info>
SSO functionality is available on our [Enterprise plan](https://mintlify.com/pricing?ref=sso). Please{" "}
SSO functionality is available on our [Enterprise
plan](https://mintlify.com/pricing?ref=sso). Please{" "}
<a href="mailto:[email protected]">contact sales</a> for more information.
</Info>

Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us!

Check warning on line 12 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L12

Did you really mean 'Okta'?

## Okta

Check warning on line 14 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L14

Did you really mean 'Okta'?

<Tabs>
<Tab title="SAML">
Expand Down Expand Up @@ -46,7 +47,7 @@
</Step>
<Step title="Send us your IdP information">
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.

Check warning on line 50 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L50

Did you really mean 'Okta'?
</Step>
</Steps>
</Tab>
Expand Down Expand Up @@ -90,5 +91,41 @@
</Step>
</Steps>
</Tab>
</Tabs>

## Microsoft Entra

Check warning on line 96 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L96

Did you really mean 'Entra'?

</Tabs>
<Tabs>
<Tab title="SAML">
<Steps>
<Step title="Create an application">
1. Under "Enterprise applications", select **New application**.
2. Select **Create your own application** and choose "Integrate any other application you don't find in the gallery (Non-gallery)."
</Step>
<Step title="Configure SAML">
Navigate to the Single Sign-On setup page and select **SAML**. Under "Basic SAML Configuration," enter the following:
* Identifier (Entity ID): The Audience URI provided by Mintlify.
* Reply URL (Assertion Consumer Service URL): The ACS URL provided by Mintlify.

Leave the other values blank and select **Save**.
</Step>
<Step title="Configure Attributes & Claims">
Edit the Attributes & Claims section:
1. Select **Unique User Identifier (Name ID)** under "Required Claim."
2. Change the Source attribute to use `user.primaryauthoritativeemail`.
3. Under Additional claims, create the following claims:
| Name | Value |
| ---- | ----- |
| `firstName` | `user.givenname` |
| `lastName` | `user.surname` |
</Step>
<Step title="Send Mintlify your IdP information">
Once the application is set up, navigate to the "SAML Certificates" section and send us the App Federation Metadata URL.
We'll enable the connection from our side using this information.
</Step>
<Step title="Assign Users">
Navigate to "Users and groups" in your Entra application and add the users who should have access to your dashboard.
</Step>
</Steps>
</Tab>
</Tabs>