-
Notifications
You must be signed in to change notification settings - Fork 207
docs: instructions for entra sso #801
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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! | ||
|
|
||
| ## Okta | ||
|
|
||
| <Tabs> | ||
| <Tab title="SAML"> | ||
|
|
@@ -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. | ||
| </Step> | ||
| </Steps> | ||
| </Tab> | ||
|
|
@@ -90,5 +91,41 @@ | |
| </Step> | ||
| </Steps> | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Microsoft 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> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.