mintlify__docs/zh/dashboard/sso.mdx

---
title: "单点登录（SSO）"
description: "使用身份提供商通过 SAML 或 OIDC 为团队设置认证。"
keywords: ["SAML 认证", "OIDC", "Okta 集成", "身份提供商"]
---

<Info>
  SSO 功能适用于 [自定义套餐](https://mintlify.com/pricing?ref=sso)。
</Info>

通过 SAML 和 OIDC 为你的控制台启用单点登录。如果你使用 Okta、Google Workspace 或 Microsoft Entra，我们提供相应的提供商专用文档来帮助你完成 SSO 设置。若你使用其他提供商，请[联系我们](mailto:support@mintlify.com)。

<div id="okta">
  ## Okta
</div>

<Tabs>
    <Tab title="SAML">
        <Steps>
            <Step title="创建应用">
                在 `Applications` 中，点击创建一个使用 SAML 2.0 的新应用集成。
            </Step>
            <Step title="配置集成">
                输入以下内容：
                * 单点登录 URL（由 Mintlify 提供）
                * 受众 URI（Audience URI，由 Mintlify 提供）
                * Name ID Format：`EmailAddress`
                * 属性声明（Attribute Statements）：
                    | 名称 | 名称格式 | 值
                    | ---- | -------- | -----
                    | `firstName` | Basic | `user.firstName` |
                    | `lastName` | Basic | `user.lastName` |
            </Step>
            <Step title="将你的 IdP 信息发送给我们">
                应用设置完成后，前往 Sign-On 标签页，并将 metadata URL 发送给我们。
                我们将根据这些信息在我们这边启用连接。
            </Step>
        </Steps>
    </Tab>
    <Tab title="OIDC">
        <Steps>
            <Step title="创建应用">
                在 `Applications` 中，点击创建一个使用 OIDC 的新应用集成。
                请选择 `Web Application` 应用类型。
            </Step>
            <Step title="配置集成">
                选择授权码（authorization code）授权类型，并输入由 Mintlify 提供的重定向 URI（Redirect URI）。
            </Step>
            <Step title="将你的 IdP 信息发送给我们">
                应用设置完成后，前往 General 标签页，找到 Client ID 和 Client Secret。
                请将这些信息以及你的 Okta 实例 URL（例如，`<your-tenant-name>.okta.com`）以安全方式提供给我们。你可以通过 1Password 或 SendSafely 等服务发送。
            </Step>
        </Steps>
    </Tab>
</Tabs>

<div id="google-workspace">
  ## Google Workspace
</div>

<Tabs>
    <Tab title="SAML">
        <Steps>
            <Step title="创建应用">
                在 `Web and mobile apps` 下，从 `Add app` 下拉菜单中选择 `Add custom SAML app`。  
                <Frame>
                    ![Google Workspace SAML 应用创建页面的截图，其中高亮显示了“Add custom SAML app”菜单项](/images/gsuite-add-custom-saml-app.png)
                </Frame>              
            </Step>
            <Step title="向我们提供 IdP 信息">
                复制提供的 SSO URL、Entity ID 和 x509 证书，并发送给 Mintlify 团队。
                <Frame>
                    ![Google Workspace SAML 应用页面的截图，其中高亮显示了 SSO URL、Entity ID 和 x509 证书。每项的具体值均已模糊处理。](/images/gsuite-saml-metadata.png)                    
                </Frame>
            </Step>
            <Step title="配置集成">
                在 Service provider details 页面中，填写以下内容：
                * ACS URL（由 Mintlify 提供）
                * Entity ID（由 Mintlify 提供）
                * Name ID format: `EMAIL`
                * Name ID: `Basic Information > Primary email`

                <Frame>
                    ![Service provider details 页面截图，其中高亮显示了 ACS URL 和 Entity ID 输入字段。](/images/gsuite-sp-details.png)
                </Frame>

                在下一页，输入以下属性声明：
                | Google Directory Attribute | App Attribute |
                | -------------------------- | ------------- |
                | `First name` | `firstName`  |
                | `Last name` | `lastName` |

                完成此步骤并将用户分配到该应用后，请告知我们的团队，我们将为您的账号启用 SSO！
            </Step>
        </Steps>
    </Tab>
</Tabs>

<div id="microsoft-entra">
  ## Microsoft Entra
</div>

<Tabs>
    <Tab title="SAML">
        <Steps>
            <Step title="创建应用">
                1. 在“Enterprise applications”下选择 **New application**。
                2. 选择 **Create your own application**，并选择“Integrate any other application you don't find in the gallery (Non-gallery)”。
            </Step>
            <Step title="配置 SAML">
                前往 Single Sign-On 设置页面并选择 **SAML**。在“Basic SAML Configuration”中输入：
                * Identifier (Entity ID)：Mintlify 提供的 Audience URI。
                * Reply URL (Assertion Consumer Service URL)：Mintlify 提供的 ACS URL。
                
                其余项留空并选择 **Save**。
            </Step>
            <Step title="配置 Attributes & Claims">
                编辑 Attributes & Claims 部分：
                1. 在“Required Claim”下选择 **Unique User Identifier (Name ID)**。
                2. 将 Source 属性更改为使用 `user.primaryauthoritativeemail`。
                3. 在 Additional claims 下，创建以下声明：
                    | Name | Value |
                    | ---- | ----- |
                    | `firstName` | `user.givenname` |
                    | `lastName` | `user.surname` |
            </Step>
            <Step title="将您的 IdP 信息发送给 Mintlify">
                设置好应用后，前往“SAML Certificates”部分并将 App Federation Metadata URL 发送给我们。
                我们将使用这些信息在我们这端启用连接。
            </Step>
            <Step title="分配用户">
                在您的 Entra 应用中前往“Users and groups”，添加需要访问您控制台的用户。
            </Step>
        </Steps>
    </Tab>
</Tabs>