为丰富化任务配置外部连接器

借助第三方身份验证提供方,您可以将 Knowledge Studio 扩充任务安全地连接到外部平台,例如 GitHub、Microsoft SharePoint 和 Atlassian(Confluence 和 Jira)。在前提条件设置过程中,完成本文档中的凭证生成和身份验证提供方配置步骤。

准备工作

在配置外部连接器之前,请完成以下前提条件:

  • 查看整体丰富配置工作流。如需了解详情,请参阅配置丰富化任务的前提条件。
  • 确保您在目标第三方平台(GitHub、Microsoft SharePoint 或 Atlassian Confluence 和 Jira)中拥有必要的管理员或开发者权限,以便生成访问令牌或注册应用。
  • 如需安全地存储凭据并将其附加到任务,请配置代理身份服务。如需了解详情,请参阅配置丰富任务的前提条件中的“为身份验证提供方设置 IAM 权限”部分。

将丰富代理连接到第三方知识源时,您必须使用 Google Cloud 代理身份服务。Agent Identity 充当身份验证管理器,可安全地存储您的第三方凭证,并为扩充代理提供短期访问令牌,这样人工操作员就无需在任务执行期间直接管理原始客户端密钥。

配置 GitHub

如需将 Knowledge Studio 连接到 GitHub 代码库,您必须在 GitHub 中创建精细的个人访问令牌 (PAT),并将其存储在 API 密钥身份验证提供方中。

  1. 登录 GitHub,点击您的个人资料照片,然后点击设置。
  2. 依次前往 Developer settings(开发者设置)> Personal access tokens(个人访问令牌)> Fine-grained tokens(精细令牌)。
  3. 点击生成新令牌。
  4. 配置令牌属性:
    • 令牌名称:输入描述性名称(例如 enrichment-agent)。
    • 到期时间:设置适当的到期日期。
    • 资源所有者:选择拥有目标代码库的组织或用户账号。
    • 代码库访问权限:选择仅选择代码库,然后选择要扩充的代码库。
    • 权限:为所需范围(例如问题、拉取请求和内容)授予特定的读取或读取和写入访问权限。
  5. 点击生成令牌,然后安全地复制令牌。
  6. 在 Google Cloud 中注册 API 密钥身份验证提供方,并提供 PAT 作为 API 密钥。

如需了解如何注册 API 密钥身份验证提供方,请参阅配置 API 密钥身份验证提供方中的“创建 API 密钥身份验证提供方”部分。如需详细了解如何创建 PAT,请参阅 GitHub 文档中的管理个人访问令牌。

配置 Microsoft SharePoint

如果您要连接到 Microsoft SharePoint,请使用 2-Legged OAuth 流程从 Microsoft Entra ID(以前称为 Azure Active Directory)获取 OAuth 凭证。

  1. 在 Microsoft Entra 管理中心内注册应用。
  2. 授予 Microsoft Graph API 权限:
    1. 依次点击 API permissions(API 权限)> Add a permission(添加权限)> Microsoft Graph > Application permissions(应用程序权限)(请勿选择 Delegated permissions [委托权限])。
    2. 添加 Sites.Read.All 和 Files.Read.All 范围。
    3. 点击租户对应的授予管理员同意书,使两项应用权限都显示为“已授予”。
  3. 创建客户端密钥并立即记录其值,因为它仅显示一次。

  4. 复制应用配置值。注册后,收集以下值以用于身份验证提供方配置:

    • 客户端 ID:应用概览中的应用(客户端)ID。
    • 令牌网址:在概览页面上,点击端点标签页。复制标记为 OAuth 2.0 令牌端点 (v2) 的网址。
  5. 使用这些密钥在 Google Cloud 中注册一个两方模式 OAuth 身份验证提供方。创建提供方时,请向 --allowed-scopes 参数提供默认范围:

    --allowed-scopes="https://graph.microsoft.com/.default"
    

如需详细了解如何注册应用和创建客户端密钥,请参阅 Microsoft Entra 文档中的向 Microsoft 身份平台注册应用和创建新的客户端密钥。

配置 Atlassian Confluence 和 Jira

由于 Atlassian 不支持服务器到服务器代理的双向 OAuth,因此您必须在 Atlassian 中创建专用服务账号(或专用用户账号),为其授予所需权限,并生成 PAT。

  1. 在 Atlassian 中登录专用服务账号。
  2. 点击您的个人资料照片,然后从菜单中选择设置(或账号设置)。
  3. 在安全标签页中,前往 API 令牌部分。
  4. 点击创建具有范围的 API 令牌。请勿使用无范围令牌,因为它不会提取所有必需的工具。
  5. 提供一个描述性名称(例如 enrichment-agent),配置失效日期,然后点击下一步。
  6. 在选择应用列表中,选择 Atlassian MCP,然后点击下一步。
  7. 选择以下所有 Confluence 和 Jira 读取和搜索范围:
    • read:page:confluence
    • read:space:confluence
    • search:confluence
    • read:confluence-content.all
    • read:confluence-content.summary
    • read:confluence-space.summary
    • search:rovo:mcp
    • read:jira-work
  8. 点击下一步,然后点击创建。
  9. 复制生成的令牌。
  10. 将 Google Cloud 身份验证提供方的凭据字符串格式设置为ATLASSIAN_EMAIL:API_TOKEN。Atlassian 要求使用 HTTP 基本身份验证编码 (email:api_token) 以编程方式使用个人 API 令牌。
  11. 在 Google Cloud 中注册 API 密钥身份验证提供方,并提供ATLASSIAN_EMAIL:API_TOKEN字符串作为 API 密钥。

如需了解如何注册 API 密钥身份验证提供方,请参阅配置 API 密钥身份验证提供方中的“创建 API 密钥身份验证提供方”部分。如需详细了解如何创建 PAT,请参阅 Atlassian 文档中的管理 Atlassian 账号的 API 令牌。

后续步骤