> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-hello-world-quickstart-48843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Single sign-on (SSO)

> 自定义团队登录管理控制台的方式

<Info>
  SSO 功能适用于 [Enterprise 方案](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（由 Mintlify 提供）
        * Name ID Format：`EmailAddress`
        * Attribute Statements：
          | Name        | Name format | Value            |
          | ----------- | ----------- | ---------------- |
          | `firstName` | Basic       | `user.firstName` |
          | `lastName`  | Basic       | `user.lastName`  |
      </Step>

      <Step title="将您的 IdP 信息发送给我们">
        应用设置完成后，前往 Sign-On 选项卡，并将元数据 URL 发送给我们。
        我们会根据这些信息在我们这边启用连接。
      </Step>
    </Steps>
  </Tab>

  <Tab title="OIDC">
    <Steps>
      <Step title="创建应用">
        在 `Applications` 中，点击使用 OIDC 创建新的应用集成。
        请选择 `Web Application` 应用类型。
      </Step>

      <Step title="配置集成">
        选择授权码（Authorization Code）授权类型，并输入由 Mintlify 提供的 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="Create an application">
        在 `Web and mobile apps` 下，从 `Add app` 下拉菜单中选择 `Add custom SAML app`。

        <Frame>
          <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/gsuite-add-custom-saml-app.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=3c22d39ebbc32ac243f02fbb74456e35" alt="" width="3804" height="1860" data-path="images/gsuite-add-custom-saml-app.png" />
        </Frame>
      </Step>

      <Step title="Send us your IdP information">
        复制提供的 SSO URL、Entity ID 和 x509 证书，并发送给 Mintlify 团队。

        <Frame>
          <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/gsuite-saml-metadata.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=0c7cf8e29c08986b0b4aff2f8679c238" alt="" width="3800" height="1850" data-path="images/gsuite-saml-metadata.png" />
        </Frame>
      </Step>

      <Step title="Configure integration">
        在 Service provider details 页面中，输入以下内容：

        * ACS URL（由 Mintlify 提供）
        * Entity ID（由 Mintlify 提供）
        * Name ID format：`EMAIL`
        * Name ID：`Basic Information > Primary email`

        <Frame>
          <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/gsuite-sp-details.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=389cfe426c177e3afcff224ca6bcbdb0" alt="" width="3788" height="1864" data-path="images/gsuite-sp-details.png" />
        </Frame>

        在下一页中，输入以下属性声明（attribute statements）：

        | 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="Create an application">
        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="Configure 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="Configure Attributes & Claims">
        编辑 Attributes & Claims 部分：

        1. 在 “Required Claim” 下选择 **Unique User Identifier (Name ID)**。
        2. 将 Source attribute 更改为使用 `user.primaryauthoritativeemail`。
        3. 在 Additional claims 下创建以下声明（claims）：
           | Name        | Value            |
           | ----------- | ---------------- |
           | `firstName` | `user.givenname` |
           | `lastName`  | `user.surname`   |
      </Step>

      <Step title="Send Mintlify your IdP information">
        设置好应用后，前往 “SAML Certificates” 部分，并将 App Federation Metadata URL 发送给我们。
        我们会据此在我们端启用该连接。
      </Step>

      <Step title="Assign Users">
        在你的 Entra 应用中进入 “Users and groups”，添加应当访问你仪表板的用户。
      </Step>
    </Steps>
  </Tab>
</Tabs>