mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
131 lines
6.2 KiB
Plaintext
131 lines
6.2 KiB
Plaintext
---
|
|
title: "Single sign-on (SSO)"
|
|
description: "Set up SAML or OIDC with identity providers for team authentication."
|
|
keywords: ["SAML authentication", "OIDC", "Okta integration", "identity provider"]
|
|
---
|
|
|
|
<Info>
|
|
SSO is available on [Enterprise plans](https://mintlify.com/pricing?ref=sso).
|
|
</Info>
|
|
|
|
Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:support@mintlify.com).
|
|
|
|
## Okta
|
|
|
|
<Tabs>
|
|
<Tab title="SAML">
|
|
<Steps>
|
|
<Step title="Create an application">
|
|
Under `Applications`, click to create a new app integration using SAML 2.0.
|
|
</Step>
|
|
<Step title="Configure integration">
|
|
Enter the following:
|
|
* Single sign-on URL (provided by Mintlify)
|
|
* Audience URI (provided by Mintlify)
|
|
* Name ID Format: `EmailAddress`
|
|
* Attribute Statements:
|
|
| Name | Name format | Value
|
|
| ---- | ----------- | -----
|
|
| `firstName` | Basic | `user.firstName` |
|
|
| `lastName` | Basic | `user.lastName` |
|
|
</Step>
|
|
<Step title="Send us your IdP information">
|
|
Once the application is set up, navigate to the sign-on tab and send us the metadata URL.
|
|
We'll enable the connection from our side using this information.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
<Tab title="OIDC">
|
|
<Steps>
|
|
<Step title="Create an application">
|
|
Under `Applications`, click to create a new app integration using OIDC.
|
|
You should choose the `Web Application` application type.
|
|
</Step>
|
|
<Step title="Configure integration">
|
|
Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
|
|
</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 (for example, `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Google Workspace
|
|
|
|
<Tabs>
|
|
<Tab title="SAML">
|
|
<Steps>
|
|
<Step title="Create an application">
|
|
Under `Web and mobile apps`, select `Add custom SAML app` from the `Add app` dropdown.
|
|
<Frame>
|
|
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Send us your IdP information">
|
|
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
|
|
<Frame>
|
|
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Configure integration">
|
|
On the Service provider details page, enter the following:
|
|
* ACS URL (provided by Mintlify)
|
|
* Entity ID (provided by Mintlify)
|
|
* Name ID format: `EMAIL`
|
|
* Name ID: `Basic Information > Primary email`
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
On the next page, enter the following attribute statements:
|
|
| Google Directory Attribute | App Attribute |
|
|
| -------------------------- | ------------- |
|
|
| `First name` | `firstName` |
|
|
| `Last name` | `lastName` |
|
|
|
|
Once this step is complete and users are assigned to the application, let our team know and we'll enable SSO for your account!
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Microsoft Entra
|
|
|
|
<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>
|