Atlassian Jira Cloud Microsoft Graph 连接器

Atlassian Jira Cloud Microsoft Graph 连接器允许组织为 Jira 问题编制索引。 配置连接器并索引 Jira 站点中的内容后,最终用户可以在 Microsoft 搜索中搜索这些项目。

注意

请阅读Microsoft 365 管理中心中的设置 Microsoft Graph 连接器一文,了解常规连接器设置说明。

本文适用于配置、运行和监视 Atlassian Jira Cloud 连接器的任何人。 它补充了常规设置过程,并显示仅适用于 Atlassian Jira Cloud 连接器的说明。

重要

Atlassian Jira Cloud 连接器仅支持 Jira 云托管实例。 此连接器不支持 Jira Server 和 Jira Data Center 版本。

开始之前

你必须是组织的 Microsoft 365 租户的管理员,以及组织的 Jira 站点的管理员。

需要向在连接器配置期间使用其凭据的用户帐户授予以下权限:

权限名称 权限类型 必需
浏览项目 项目权限 爬网 Jira 问题。 对于需要编制索引的项目,此权限是必需的。
问题级别安全权限 问题级别安全性 爬网不同的问题类型。 此权限是 可选的
浏览用户和组 全局权限 搜索结果的 ACL 剪裁。 此权限是 可选的 ,需要在 Only people with access to this data source 下面的步骤 4 中选择选项。
管理 Jira 全局权限 搜索结果的 ACL 剪裁。 此权限是 可选的 ,需要在 Only people with access to this data source 下面的步骤 4 中选择选项。

步骤 1:在Microsoft 365 管理中心中添加连接器

添加 Jira 连接器

按照常规 设置说明进行操作

步骤 2:命名连接

按照常规 设置说明进行操作

步骤 3:配置连接设置

若要连接到 Jira 站点,请使用 Jira 站点 URL。 Jira 云站点 URL 通常类似于 https://< organization_name.atlassian.net/>。 可以选择“基本身份验证”或“OAuth 2.0”, (建议) 向 Jira 站点进行身份验证。

基本身份验证

输入帐户的用户名 (通常为电子邮件 ID) 和 API 令牌,以便使用基本身份验证进行身份验证。若要了解有关生成 API 令牌的详细信息,请参阅 Atlassian 的文档,了解如何 管理 Atlassian 帐户的 API 令牌

OAuth 2.0

在 Atlassian Jira 中注册应用,以便 Microsoft 搜索应用可以访问该实例。 若要了解详细信息,请参阅 Atlassian 支持文档,了解如何 启用 OAuth 2.0

以下步骤提供了有关如何注册应用的指南:

  1. 使用 Atlassian Jira 管理员帐户登录到 Atlassian 开发人员控制台。

  2. 选择“打开Create”,然后选择 。OAuth 2.0 integration

  3. 为应用程序提供适当的名称并创建新应用。

  4. Permissions从左侧导航窗格导航到 。 在“粒度权限”标头下,选择 AddJira API 添加后,选择并 Configure 添加下面列出的以下范围。

    # 范围名称 代码
    1 查看字段 read:field:jira
    2 查看头像 read:avatar:jira
    3 查看项目类别 read:project-category:jira
    4 查看项目 read:project:jira
    5 读取字段配置 read:field-configuration:jira
    6 查看问题类型 read:issue-type:jira
    7 查看项目属性 read:project.property:jira
    8 查看用户 read:user:jira
    9 查看应用程序角色 read:application-role:jira
    10 查看组 read:group:jira
    11 读取问题类型层次结构 read:issue-type-hierarchy:jira
    12 查看项目版本 read:project-version:jira
    13 查看项目组件 read:project.component:jira
    14 查看问题详细信息 read:issue-details:jira
    15 查看审核日志 read:audit-log:jira
    16 查看问题元 read:issue-meta:jira
    17 查看项目角色 read:project-role:jira
    18 查看问题安全级别 read:issue-security-level:jira
    19 查看问题安全方案 read:issue-security-scheme:jira
    20 查看权限方案 read:permission-scheme:jira
    21 查看权限 read:permission:jira
  5. Authorization从左侧导航窗格导航到 。 添加 M365 企业版的回调 URL: https://gcs.office.com/v1.0/admin/oauth/callback,用于 M365 政府版: https://gcsgcc.office.com/v1.0/admin/oauth/callback 并保存更改。

  6. Settings从左侧导航窗格导航到 。 你将从此页面获取 Client IDSecret

使用 客户端 ID机密完成连接设置步骤。

注意

  • 若要详细了解 Jira 权限,请参阅 OAuth 2.0 应用 的范围列表
  • Jira 云将弃用原始 (经典) OAuth 权限。 有关详细信息,请参阅 更改日志公告

步骤 3a:配置数据:选择项目

可以选择为连接编制索引,以便仅对整个 Jira 站点或特定项目编制索引。

  • 如果选择为整个 Jira 网站编制索引,则站点中所有项目中的 Jira 问题都将编制索引。 创建新项目和问题后,将在下次爬网期间为新项目和问题编制索引。
  • 如果选择单个项目,则只会为这些项目中的 Jira 问题编制索引。

注意

向 Jira 项目授予“浏览项目 ”权限时,将列出该权限,并且可以对其进行爬网。 如果缺少项目,检查帐户的权限。

可以进一步选择筛选将以两种方式编制索引的 Jira 问题。

  • 指定 问题修改时间段。 这只会根据当前爬网对在 所选 时间段内创建或修改的 Jira 问题编制索引。
  • 指定 JQL。 这只会根据提供的 Jira 查询语言 (JQL) 对筛选后返回的 Jira 问题编制索引。 若要详细了解如何使用 JQL,请参阅 Atlassian 支持文档,了解如何 通过 Jira 查询语言使用高级搜索

提示

可以使用 JQL 筛选器仅使用“ (Bug 中的 issueType,改进) ”为 特定 Jira 问题类型编制索引

步骤 3b:配置数据:选择属性

在继续操作之前,选择要让连接为这些字段中的数据编制索引和预览的字段。 某些字段已默认处于选中状态,无法删除。

Atlassian Jira 连接器可以为默认问题字段和自定义创建的问题字段编制索引。

注意

如果某些 Jira 问题类型 () 中不存在所选的自定义创建字段,则该字段将以 NULL (空白) 引入。

步骤 4:管理搜索权限

Atlassian Jira 连接器支持对有权访问此数据源的所有人或仅人员可见的搜索权限。 如果选择“ 所有人”,则索引数据将显示在所有用户的搜索结果中。 如果选择“ 仅有权访问此数据源的人员”,则索引数据将显示在有权访问这些数据源的用户的搜索结果中。 在 Atlassian Jira 中,安全权限是使用包含站点级别组和项目角色的项目权限方案定义的。 也可以使用问题级别权限方案定义问题级别安全性。

重要

Jira cloud Graph 连接器必须能够在 Jira 中读取用户的电子邮件 ID,才能在 Microsoft 搜索中适当分配安全权限。 这要求你确保以下任一项:

  • 所有用户都应为其配置文件可见性设置选择了“任何人”选项。 若要了解有关配置文件可见性设置的详细信息,请参阅 Atlassian 的文档
  • 对于使用“托管帐户”的组织 (所有具有已验证域电子邮件地址的 Atlassian 帐户都将成为托管帐户。有关详细信息,请参阅 此文档) -
  • 属于托管帐户的所有用户必须在配置文件可见性设置中选择托管帐户设置。
  • 不属于托管帐户的用户 (与爬网帐户) 相同,需要在个人资料可见性设置中选择“任何人”。
  • 在连接配置期间使用的爬网帐户必须具有托管帐户域。

如果选择“仅有权访问此数据源的人员”,则需要进一步选择 Jira 站点是Microsoft Entra ID预配用户还是非 Azure AD 用户。

若要确定哪个选项适合你的组织,请执行以下操作:

  1. 如果 Jira 用户的Email ID 与 Microsoft Entra ID 中用户的 UserPrincipalName (UPN) 相同,请选择“Microsoft Entra ID”选项。
  2. 如果 Jira 用户的电子邮件 ID 不同于 userPrincipalName (UPN) Microsoft Entra ID 用户的电子邮件 ID,请选择“非 Azure AD”选项。

注意

  • 如果选择Microsoft Entra ID作为标识源的类型,连接器会将从 Jira 获取的用户的Email ID 直接映射到Microsoft Entra ID的 UPN 属性。
  • 如果为标识类型选择“非 Azure AD”,请参阅[映射非 Azure AD 标识] (映射非 Azure AD.md) ,获取有关映射标识的说明。 可以使用此选项提供从 Email ID 到 UPN 的映射正则表达式。
  • 汇报管理访问权限的用户或组仅在完全爬网中同步。 增量爬网当前不支持处理权限更新。

步骤 5:分配属性标签

按照常规 设置说明进行操作

步骤 6:管理架构

按照常规 设置说明进行操作

步骤 7:选择刷新设置

Atlassian Jira 连接器支持完全爬网和增量爬网的刷新计划。 建议的增量爬网计划为 1 小时,完全爬网为 1 天。

步骤 8:查看连接

按照常规 设置说明进行操作

发布连接后,需要自定义搜索结果页。 若要了解如何自定义搜索结果,请参阅 自定义搜索结果页

步骤 9:设置搜索结果页

发布连接后,需要使用垂直和结果类型自定义搜索结果页。 若要了解如何自定义搜索结果,请查看如何 管理垂直结果类型。 还可以使用 Jira 连接器 的示例结果布局 。 只需复制粘贴结果布局 JSON 即可开始使用。

疑难解答

下面是在配置连接器时或爬网期间观察到的常见错误及其可能的原因的列表。

步骤 错误消息 () 的可能原因
连接设置 该请求格式有误或不正确。 Jira 站点 URL 不正确。
连接设置 无法访问 Jira 站点的 Jira 云服务。 Jira 站点 URL 不正确。
连接设置 客户端没有执行操作的权限。 为基本身份验证提供的 API 令牌无效。
连接设置 OAuth 弹出窗口中的“出错”错误。 授予 OAuth 应用的范围不匹配。 弹出窗口中列出了不匹配的范围。
连接器配置) 后 (爬网时间 无法使用数据源进行身份验证。 验证与此数据源关联的凭据是否正确。 用户没有对 Jira 进行爬网所需的一个或多个权限。
连接器配置) 后 (爬网时间 你没有访问此数据源的权限。 可以联系此数据源的所有者以请求权限。 如果使用的是 OAuth,则应用范围可能已更改,或者应用可能已过期或删除。
如果使用基本身份验证,API 令牌可能已过期或删除。

限制

Atlassian Jira 连接器的已知限制如下:

  • 连接器不支持“任何用户登录”应用程序角色来授予对问题的访问权限。
  • 不支持 Jira Server 和 Data Center 版本。