Skip to content

Latest commit

 

History

History
94 lines (84 loc) · 3.88 KB

sso.mdx

File metadata and controls

94 lines (84 loc) · 3.88 KB
title description
Single Sign-On (SSO)
Customize how your team can login to your admin dashboard

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!

SSO functionality is available on our Enterprise plan. [Contact us](https://mintlify.com/enterprise) to learn more!

Okta

Under `Applications`, click to create a new app integration using SAML 2.0. 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` | 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. Under `Applications`, click to create a new app integration using OIDC. You should choose the `Web Application` application type. Select the authorization code grant type and enter the Redirect URI provided by Mintlify. 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. `.okta.com`). You can send these via a service like 1Password or SendSafely.

Google Workspace

Under `Web and mobile apps`, select `Add custom SAML app` from the `Add app` dropdown. ![](/images/gsuite-add-custom-saml-app.png) Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team. ![](/images/gsuite-saml-metadata.png) 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>
                ![](/images/gsuite-sp-details.png)
            </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>