mintlify__docs/zh/guides/auth0.mdx

---
title: "使用 Auth0 完成 OAuth 握手"
description: "将 Auth0 配置为 OAuth 提供方以对用户进行认证。"
keywords: ["Auth0", "OAuth flow"]
---

<Note>
  **安全声明**：本指南旨在帮助你将 Auth0 与 Mintlify 集成；在实施任何认证方案之前，请务必咨询你的安全团队。对于因你的具体实现而产生的任何安全问题，Mintlify 不承担责任。
</Note>

<div id="overview">
  ## 概览
</div>

本指南将引导你将 Auth0 配置为 Mintlify 文档的认证提供商。完成后，你的用户即可使用其 Auth0 凭证登录你的文档。

<Steps>
  <Step title="在 Auth0 中创建 Regular Web Application">
    登录你的 Auth0 控制台，前往 **Applications** > **Applications**。点击 **Create Application** 按钮，为应用命名（例如 “Mintlify”），并选择 **Regular Web Applications** 作为应用类型。然后点击 **Create**。
    
    <Frame>![在 Auth0 中创建新应用](/images/guides/auth0/auth0-create-application.png)</Frame>
  </Step>
  <Step title="获取客户端信息">
    创建应用后，你会进入应用设置页面。在这里可以找到进行 OAuth 集成所需的关键信息：
    
    <Frame>![Auth0 客户端设置页面](/images/guides/auth0/auth0clientsettings.png)</Frame>
    
    请记录以下信息：
    - **Domain**：你的 Auth0 租户 domain（例如 `your-tenant.auth0.com`）
    - **Client ID**：应用的公共标识符
    - **Client Secret**：应用的密钥（请妥善保管）
    
    你将在下一步配置 Mintlify 时用到这些值。
  </Step>
  <Step title="设置 Mintlify 客户端">
    前往你的 Mintlify 控制台，进入 **Settings** > **Authentication**。选择 **OAuth** 作为认证方式，你将看到 OAuth 配置表单：
    
    <Frame>![Mintlify OAuth 客户端设置](/images/guides/auth0/mintlifyoauthclientsettings.png)</Frame>
    
    按如下内容填写表单：
    
    - **Authorization URL**：`https://YOUR_AUTH0_DOMAIN/authorize`（将 `YOUR_AUTH0_DOMAIN` 替换为第 2 步中的实际 Auth0 domain）
    - **Client ID**：填入 Auth0 应用中的 Client ID
    - **Client Secret**：填入 Auth0 应用中的 Client Secret
    - **Scopes**：留空，除非你在 Auth0 中设置了自定义 scope
    - **Token URL**：`https://YOUR_AUTH0_DOMAIN/oauth/token`（将 `YOUR_AUTH0_DOMAIN` 替换为你的实际 Auth0 domain）
    
    填写完毕后，点击 **Save changes** 保存 OAuth 配置。
  </Step>
  <Step title="配置 Callback URL">
    Mintlify 会生成一个唯一的 Redirect URL，Auth0 需要识别该地址以确保 OAuth 流程正常运行。
    
    在 Mintlify 控制台的 Authentication 设置中复制该 Redirect URL：
    <Frame>![Mintlify 重定向 URL](/images/guides/auth0/mintlifyredirecturl.png)</Frame>
    
    返回 Auth0 应用设置页面，向下滚动至 **Application URIs**，并将该 Redirect URL 粘贴到 **Allowed Callback URLs** 字段：
    <Frame>![Auth0 重定向 URL 配置](/images/guides/auth0/auth0redirecturl.png)</Frame>
    
    点击 Auth0 页面底部的 **Save Changes** 以应用配置。
  </Step>
</Steps>