Single sign-on (SSO)
Customize how your team can login to your admin dashboard
SSO functionality is available on Enterprise plan.
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.
Okta
Create an application
Under Applications, click to create a new app integration using SAML 2.0.
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 firstNameBasic user.firstNamelastNameBasic user.lastName
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.
Create an application
Under Applications, click to create a new app integration using SAML 2.0.
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 firstNameBasic user.firstNamelastNameBasic user.lastName
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.
Create an application
Under Applications, click to create a new app integration using OIDC.
You should choose the Web Application application type.
Configure integration
Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
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.
Google Workspace
Create an application
Under Web and mobile apps, select Add custom SAML app from the Add app dropdown.
Send us your IdP information
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
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
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!
Create an application
Under Web and mobile apps, select Add custom SAML app from the Add app dropdown.
Send us your IdP information
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
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
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!
Microsoft Entra
Create an application
- Under “Enterprise applications”, select New application.
- Select Create your own application and choose “Integrate any other application you don’t find in the gallery (Non-gallery).”
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.
Configure Attributes & Claims
Edit the Attributes & Claims section:
- Select Unique User Identifier (Name ID) under “Required Claim.”
- Change the Source attribute to use
user.primaryauthoritativeemail. - Under Additional claims, create the following claims:
Name Value firstNameuser.givennamelastNameuser.surname
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.
Assign Users
Navigate to “Users and groups” in your Entra application and add the users who should have access to your dashboard.
Create an application
- Under “Enterprise applications”, select New application.
- Select Create your own application and choose “Integrate any other application you don’t find in the gallery (Non-gallery).”
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.
Configure Attributes & Claims
Edit the Attributes & Claims section:
- Select Unique User Identifier (Name ID) under “Required Claim.”
- Change the Source attribute to use
user.primaryauthoritativeemail. - Under Additional claims, create the following claims:
Name Value firstNameuser.givennamelastNameuser.surname
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.
Assign Users
Navigate to “Users and groups” in your Entra application and add the users who should have access to your dashboard.