> ## Documentation Index
> Fetch the complete documentation index at: https://omer-914cc1c6.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，我们提供了相应的提供商专用设置文档。若你使用其他提供商，请[联系我们](mailto:support@mintlify.com)。

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

<Tabs>
  <Tab title="SAML">
    <Steps>
      <Step title="Create an application">
        在 `Applications` 下，点击创建一个基于 SAML 2.0 的新应用集成。
      </Step>

      <Step title="Configure integration">
        输入以下内容：

        * 单点登录 URL（由 Mintlify 提供）
        * 受众 URI（Audience URI，由 Mintlify 提供）
        * Name ID Format：`EmailAddress`
        * 属性声明（Attribute Statements）：
          | 名称          | 名称格式  | 值                |
          | ----------- | ----- | ---------------- |
          | `firstName` | Basic | `user.firstName` |
          | `lastName`  | Basic | `user.lastName`  |
      </Step>

      <Step title="Send us your IdP information">
        应用设置完成后，进入 Sign-On 标签页，并将 metadata URL 发送给我们。
        我们将据此在我们端启用连接。
      </Step>
    </Steps>
  </Tab>

  <Tab title="OIDC">
    <Steps>
      <Step title="Create an application">
        在 `Applications` 下，点击创建一个基于 OIDC 的新应用集成。
        请选择 `Web Application` 应用类型。
      </Step>

      <Step title="Configure integration">
        选择授权码（authorization code）授权类型，并输入 Mintlify 提供的 Redirect URI。
      </Step>

      <Step title="Send us your IdP information">
        应用设置完成后，进入 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>
          <img src="https://mintcdn.com/omer-914cc1c6/1pfjDJXEL6HIHDKE/images/gsuite-add-custom-saml-app.png?fit=max&auto=format&n=1pfjDJXEL6HIHDKE&q=85&s=9f3f2d3356c7c5dd54e9ccb1f0d56a76" alt="" width="3804" height="1860" data-path="images/gsuite-add-custom-saml-app.png" />
        </Frame>
      </Step>

      <Step title="将你的 IdP 信息发送给我们">
        复制提供的 SSO URL、Entity ID 和 x509 证书，并发送给 Mintlify 团队。

        <Frame>
          <img src="https://mintcdn.com/omer-914cc1c6/1pfjDJXEL6HIHDKE/images/gsuite-saml-metadata.png?fit=max&auto=format&n=1pfjDJXEL6HIHDKE&q=85&s=d649dec5d1370af40672e45517bb338a" alt="" width="3800" height="1850" data-path="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>
          <img src="https://mintcdn.com/omer-914cc1c6/1pfjDJXEL6HIHDKE/images/gsuite-sp-details.png?fit=max&auto=format&n=1pfjDJXEL6HIHDKE&q=85&s=9056b0b140d2efe3e8dce393589934bf" alt="" width="3788" height="1864" data-path="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="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 属性更改为使用 `user.primaryauthoritativeemail`。
        3. 在 Additional 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>