使用 OAuth 2.0 将 Amazon OpenSearch Ingestion 管道连接到 Atlassian Jira 或 Confluence - Amazon OpenSearch Service
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

使用 OAuth 2.0 将 Amazon OpenSearch Ingestion 管道连接到 Atlassian Jira 或 Confluence

使用本主题中的信息,帮助您使用 OAuth 2.0 身份验证配置 Amazon OpenSearch Ingestion 管道并将其连接到 Jira 或 Confluence 账户。当借助 Atlassian Services 使用 OpenSearch Ingestion 管道完成 先决条件,但选择不使用 API 密钥凭证时,请执行此任务。

创建 OAuth 2.0 集成应用程序

使用以下步骤,帮助您在 Atlassian Developer 网站上创建 OAuth 2.0 集成应用程序。

创建 OAuth 2.0 集成应用程序
  1. 登录 Atlassian Developer 账户,网址为 https://developer.atlassian.com/console/myapps/

  2. 选择创建OAuth 2.0 集成

  3. 对于名称,输入名称以标识应用程序的用途。

  4. 选择我同意遵守 Atlassian 的开发人员条款复选框,然后选择创建

  5. 在左侧导航栏中,选择授权,然后选择添加

  6. 回调 URL 中,输入任意 URL,例如 https://www.amazon.comhttps://www.example.com,然后选择保存更改

  7. 在左侧导航栏中,选择权限页面,然后在 Jira API 的行中选择添加,接着选择配置。勾选所有经典范围的读取权限(列表如下),然后选择“保存”

  8. 选择精细范围选项卡,然后选择编辑范围,以打开编辑 Jira API 对话框。

  9. 选择正在使用的源插件的权限:

    Jira
    read:audit-log:jira read:issue:jira read:issue-meta:jira read:attachment:jira read:comment:jira read:comment.property:jira read:field:jira read:field.default-value:jira read:field.option:jira read:field-configuration-scheme:jira read:field-configuration:jira read:issue-link:jira read:issue-link-type:jira read:issue-link-type:jira read:issue.remote-link:jira read:issue.property:jira read:resolution:jira read:issue-details:jira read:issue-type:jira read:issue-worklog:jira read:issue-field-values:jira read:issue.changelog:jira read:issue.transition:jira read:issue.vote:jira read:jira-expressions:jira
    Confluence
    read:content:confluence read:content-details:confluence read:space-details:confluence read:audit-log:confluence read:page:confluence read:blogpost:confluence read:custom-content:confluence read:comment:confluence read:space:confluence read:space.property:confluence read:space.setting:confluence read:content.property:confluence read:content.metadata:confluence read:task:confluence read:whiteboard:confluence read:app-data:confluence manage:confluence-configuration
  10. 选择保存

有关更多信息,请参阅 Atlassian Developer 网站上的 Implementing OAuth 2.0(3LO)Determining the scopes required for an operation

生成和刷新 Atlassian Developer 访问令牌

使用以下步骤,以帮助您在 Atlassian Developer 网站上生成和刷新 Atlassian Developer 访问令牌。

生成和刷新 Jira 访问令牌
  1. 登录 Atlassian Developer 账户,网址为 https://developer.atlassian.com/console/myapps/

  2. 选择在 创建 OAuth 2.0 集成应用程序 中创建的应用程序。

  3. 从左侧导航中,选择授权

  4. 从页面底部复制精细的 Atlassian API 授权 URL 值,然后将其粘贴到您选择的文本编辑器中。

    URL 的格式如下所示:

    https://auth.atlassian.com/authorize? audience=api.atlassian.com &client_id=YOUR_CLIENT_ID &scope=REQUESTED_SCOPE%20REQUESTED_SCOPE_TWO &redirect_uri=https://YOUR_APP_CALLBACK_URL &state=YOUR_USER_BOUND_VALUE &response_type=code &prompt=consent
  5. 对于 state=YOUR_USER_BOUND_VALUE,将参数值更改为您选择的任何值,例如 state="sample_text"。

    有关更多信息,请参阅 Atlassian Developer 网站上的 What is the state parameter used for?

  6. 请注意,scope 部分列出您在先前任务中选择的精细范围。例如:scope=read%3Ajira-work%20read%3Ajira-user%20offline_access

    offline_access 表示您要生成 refresh_token

  7. 打开 Web 浏览器窗口,在浏览器窗口的地址栏中输入您复制的授权 URL。

  8. 目标页面打开后,请确认信息准确无误,然后选择接受,以重定向至 Jira 或 Confluence 主页。

  9. 主页加载完成后,复制此页面的 URL。该 URL 包含应用程序的授权码。您可使用此代码生成访问令牌。code= 之后的整个部分即为授权码。

  10. 使用以下 cURL 命令生成访问令牌。将占位符值替换为您自己的信息。

    提示

    您也可以使用第三方服务,例如 Postman。

    curl --request POST --url 'https://auth.atlassian.com/oauth/token' \ --header 'Content-Type: application/json' \ --data '{"grant_type": "authorization_code", "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET", "code": "AUTHORIZATION_CODE", "redirect_uri": "YOUR_CALLBACK_URL"}'

    对此命令的响应包括 access_coderefresh_token 的值。