Confluence Cloud 配置

本页面介绍了如何在创建 Confluence Cloud 数据存储区之前设置和配置 Confluence Cloud 实例。

设置身份验证和权限

您需要在 Atlassian 管理员账号中心设置身份验证和权限。这对于允许连接器访问和同步数据至关重要。Confluence Cloud 连接器支持各种身份验证方法，例如 OAuth 客户端凭据或 API 令牌。

创建 OAuth 2.0 应用

如需创建用于身份验证的 OAuth 2.0 应用，请按照以下步骤在 Atlassian 开发者控制台中设置应用，并获取必要的客户端 ID 和客户端密钥。

验证 Confluence 组织管理员访问权限

如需验证 Confluence 组织管理员访问权限，请执行以下操作：

  1. 使用您的用户凭据登录 Atlassian。

  2. 选择 Confluence 应用。

  3. 点击设置。

    如果您在 Confluence 设置下看到系统选项，则表明您拥有 Confluence 组织管理员访问权限。否则，请让您的 Confluence 组织管理员授予您相应访问权限。

创建 OAuth 2.0 应用

如需创建 OAuth 2.0 应用，请执行以下操作：

  1. 登录 Atlassian 开发者控制台。

  2. 点击个人资料图标，然后选择开发者控制台。

  3. 在控制台页面中，点击创建，然后选择 OAuth 2.0 集成。

  4. 在应用创建页面中，执行以下操作：

    1. 为应用输入一个名称。

    2. 选中复选框以同意 Atlassian 的开发者条款。

    3. 点击创建。

  5. 在应用页面中，执行以下操作：

    1. 在导航菜单中，点击授权。

    2. 在授权类型表中，选择 OAuth 2.0 (3LO) 对应的添加。

  6. 在回调网址字段中，输入 https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html。

  7. 点击保存更改。

获取客户端 ID 和客户端密钥

如需获取客户端 ID 和客户端密钥，请执行以下操作：

  1. 在应用页面中，点击导航菜单中的分发。

  2. 在分发页面中，执行以下操作：

    1. 在分发控制部分中，选择修改。
    2. 在分发状态部分中，选择共享，以便修改其他字段。
    3. 在以下必填字段中输入相应信息：
      1. 在供应商部分，输入 Google。
      2. 在隐私权政策部分，输入 https://policies.google.com。
      3. 在您的应用是否会存储个人数据？部分，选择是。
      4. 选中我确认已实现个人数据报告 API 复选框。
    4. 点击保存更改。

  3. 在应用页面中，执行以下操作：

    1. 在导航菜单中，点击设置。
    2. 在设置页面中，复制您的客户端 ID 和客户端密钥。

获取实例 ID 和实例网址

  1. 获取实例 ID：

    1. 打开一个新标签页，复制实例网址，然后将 /_edge/tenant_info 附加到实例网址。例如 https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info。
    2. 点击相应链接，找到 cloudId 值。cloudId 便是您的实例 ID。

  2. 获取实例网址：

    1. 访问 atlassian.net，然后使用您的管理员账号登录。
    2. 选择要同步的应用。例如，同步第一个应用。
    3. 找到实例网址（地址栏中的子网域）。

授予管理员角色

如需在 Google Cloud 控制台中向 Confluence 管理员授予 Discovery Engine Editor 角色，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 Gemini Enterprise 页面。

  2. 前往 IAM。

    转到 IAM

  3. 找到在 Confluence 中具有管理员访问权限的用户账号，然后点击修改图标 。

  4. 向管理员授予 Discovery Engine Editor 角色。

如需向用户授予 Atlassian 管理员角色，请执行以下操作：

  1. 使用组织管理员账号登录 Atlassian。

  2. 点击菜单图标，然后选择您的组织。或者，您也可以访问 admin.atlassian.com。

  3. 在管理页面上，点击相应产品，然后选择管理用户按钮。

  4. 在用户管理下，点击群组。

  5. 在群组页面上：

    1. 点击创建群组。
    2. 为该节点组输入一个名称。

此群组会获得连接器所需的权限。添加到此群组的用户会继承这些权限。连接器会使用此群组进行身份验证和提取文档。

  1. 在群组页面上，点击添加产品。

  2. 为 Confluence 选择 User access admin 角色。

  3. 为 Confluence 管理选择 Product admin 角色。

  4. 点击授予访问权限。

  5. 点击添加群组成员，添加连接器用于进行身份验证和访问所需资源的用户账号或群组成员。

配置最低应用范围

如需配置 OAuth 2.0 并获取 Confluence 连接器设置所需的凭证，请执行以下操作：

  1. 启用 OAuth 2.0：
    1. 点击权限。
    2. 前往 Confluence API。
    3. 点击添加。
    4. 点击配置。
    5. 前往精细范围标签页，然后点击修改范围。
    6. 选择以下范围。
      • read:attachment:confluence
      • read:configuration:confluence
      • read:content.metadata:confluence
      • read:content-details:confluence
      • read:whiteboard:confluence
      • read:group:confluence
      • read:space:confluence
      • read:user:confluence
      • search:confluence
      • write:page:confluence
      • write:attachment:confluence
    7. 确认已选择所有范围，然后保存更改。

在 Confluence 中设置 API 令牌

如果您计划使用 API 令牌进行身份验证，则必须创建没有范围限制的 API 令牌。此连接器不支持有范围限制的 API 令牌。

  1. 登录 Atlassian 控制台。
  2. 点击创建 API 令牌。
  3. 为 API 令牌输入一个名称。
  4. 为 API 令牌选择一个失效日期。令牌的有效期可为 1 到 365 天。
  5. 点击创建。
  6. 保存令牌以备后用。

管理用户公开范围

如需让 Atlassian 账号中的任何人都能看到用户的邮箱，请按以下步骤操作：

  1. 登录 Atlassian 开发者控制台。

  2. 点击个人资料图标，然后选择开发者控制台。

  3. 点击用户个人资料图标，然后选择管理账号。

  4. 前往个人资料和公开范围。

  5. 前往联系信息，将谁可以查看此信息设置为任何人。

如需让 Confluence 中的任何人都能看到用户的邮箱，请按以下步骤操作：

  1. 使用您的用户凭证登录 Atlassian。

  2. 选择一个 Confluence 应用。

  3. 依次点击设置 > 系统。

  4. 在左侧窗格中，选择常规配置。

  5. 点击 Edit Settings（修改设置）。

  6. 在用户邮箱公开范围部分，选择公开。

  7. 点击更新。

安装和配置 User Identity Accessor for Confluence Cloud

如果由于 Confluence Cloud 中的隐私设置，导致用户邮箱信息默认情况下无法公开访问，那么您必须安装 User Identity Accessor for Confluence Cloud 应用才能安全地检索用户邮箱信息。如果用户邮箱信息已公开显示，则您可能不需要安装该应用。如需详细了解邮箱信息受限公开范围相关的设置，请参阅管理用户公开范围和授予角色。

角色与权限

如需安装和配置 User Identity Accessor for Confluence Cloud 应用，您必须拥有相应的管理员角色并授予所需的应用级权限。

  • 所需角色：您必须是 Confluence Site administrator 才能安装和配置该应用。
  • 应用级权限：您必须在应用安装期间授予以下权限：
    • Read Email Address：让应用能够安全地检索用户邮箱信息，即使用户的个人资料公开范围受到限制也是如此。
    • App Storage scope：让应用能够读取和写入其存储设备。

安装 User Identity Accessor for Confluence Cloud

如需在 Confluence 网站上安装 User Identity Accessor for Confluence Cloud 应用，请按以下步骤操作：

  1. 前往 Atlassian 开发者控制台。

  2. 查看读取电子邮件地址和应用存储范围权限，然后点击获取应用。

  3. 在选择要安装此应用的网站列表中，选择要安装该应用的 Confluence 网站。此列表仅显示您拥有管理员访问权限的网站。

    注意：您必须是至少一个 Confluence 网站的管理员，才能安装该应用。

  4. 点击安装以完成应用安装。

配置 User Identity Accessor for Confluence Cloud

安装 User Identity Accessor for Confluence Cloud 应用后，请配置一个 API 密钥，供您的外部系统（例如 Confluence Cloud 连接器）用于安全地调用该应用的 Web 触发器来提取邮箱信息。

访问配置页面

如需在 Confluence Cloud 中访问 User Identity Accessor for Confluence Cloud 应用的配置页面，请按以下步骤操作：

  1. 在 Confluence Cloud 实例中，点击导航菜单中的设置 ⚙️ 图标。
  2. 从菜单中选择应用。
  3. 在应用管理页面上，从管理应用列表中找到 User Identity Accessor for Confluence Cloud 应用。
  4. 点击配置或与您的应用相关联的链接。Confluence 中随即会打开该应用的专用配置页面。

设置 API 密钥

如需在配置页面上设置 API 密钥，请按照以下步骤操作：

  1. 在 API 密钥配置部分，指定用于对向应用的 Web 触发器发出的请求进行身份验证的密钥。您可以使用以下任一方法对请求进行身份验证：

    • 输入您自己的密钥：在“API 密钥”字段中输入或粘贴您自己的唯一强 API 密钥。使用至少包含 20-30 个字符的密钥，其中混合使用大写字母、小写字母、数字和符号。

    • 生成密钥：点击生成新密钥按钮。系统会在该字段中生成并显示一个随机强密钥。

      重要提示：请立即复制该字段中显示的 API 密钥。出于安全考虑，保存或离开此页面后，您可能无法再次查看完整密钥。如果该密钥丢失，您需要设置或生成一个新密钥。

  2. 点击保存 API 密钥。成功保存后，系统会显示一条消息确认密钥已安全保存。

测试应用配置

通过从外部系统发送请求并确认用户邮箱成功返回，验证 User Identity Accessor for Confluence Cloud 应用已正确配置。

获取 Web 触发器网址
  1. 在应用管理页面上，找到 Web 触发器网址部分，其中显示了您的 Confluence 网站和此应用安装的专属唯一网址：
    • 您的外部系统必须调用此网址才能请求获取用户邮箱。 例如 https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID，其中 YOUR_INSTANCE_ID 是您的 Confluence Cloud 实例标识符，WEBTRIGGER_ID 是为您的应用生成的 Web 触发器端点的唯一标识符。
  2. 点击复制网址按钮或复制整个网址。
配置外部系统

  • 使用在上文所述步骤中获得的 API 密钥和 Web 触发器网址配置需要提取 Confluence 用户邮箱信息的外部系统。

    • 端点网址：您先前复制的 Web 触发器网址。
    • HTTP 方法：POST

    • 所需标头：

      • Content-Type：application/json

      • X-Api-Key: YOUR_API_KEY

        将 YOUR_API_KEY 替换为您在设置 API 密钥部分中设置或生成的 API 密钥。

示例 curl 命令

此示例演示了如何调用 User Identity Accessor for Confluence Cloud 的 Web 触发器，该触发器接受账号 ID 数组并返回对应的邮箱信息。

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

您需要进行如下替换：

  • 将 YOUR_INSTANCE_ID 替换为您的 Confluence Cloud 实例 ID
  • 将 ENDPOINT_PATH 替换为 API 端点路径
  • 将 YOUR_API_KEY 替换为您在设置 API 密钥部分中设置或生成的 API 密钥
  • 将 ACCOUNT_ID 替换为要作为目标的 Atlassian 账号 ID
预期响应
[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

您需要进行如下替换：

  • 将 ACCOUNT_ID_X 替换为实际的 Atlassian 账号 ID
  • 将 USER_EMAIL_X 替换为通过 API 调用返回的用户邮箱

实施安全方面的最佳实践

为确保 API 密钥的安全，请遵循以下建议：

  • 在 Confluence Cloud 连接器的配置中安全地存储 API 密钥。
  • 验证与网络钩子网址的所有通信是否都是通过 HTTPS 进行。这是 User Identity Accessor for Confluence Cloud Web 触发器的默认设置。

为 User Identity Accessor for Confluence Cloud 提供支持

Google 为 User Identity Accessor for Confluence Cloud 应用提供了多种支持服务，包括维护和定期更新，以确保应用保持最新状态。如果您遇到任何问题或对应用功能有具体疑问，请与 Google Cloud 支持团队联系。