AWS amazonq documentation change
Summary
Restructured Jira authentication documentation to include OAuth 2.0 support and moved detailed configuration steps to separate pages. Updated references from 'Amazon Q' to 'Amazon Q Business'.
Security assessment
The change adds documentation for OAuth 2.0 authentication, which is a security feature improvement over basic authentication. However, there is no evidence this addresses a specific security vulnerability or incident.
Diff
diff --git a/amazonq/latest/qbusiness-ug/jira-credentials.md b/amazonq/latest/qbusiness-ug/jira-credentials.md index cb60ef1fe..0ed08b465 100644 --- a//amazonq/latest/qbusiness-ug/jira-credentials.md +++ b//amazonq/latest/qbusiness-ug/jira-credentials.md @@ -5 +5 @@ -Configuring basic authenticationRetrieving project key +# Setting up Jira for connecting to Amazon Q Business @@ -7 +7 @@ Configuring basic authenticationRetrieving project key -# Setting up Jira for connecting to Amazon Q +Before you connect Jira to Amazon Q Business, you need to create and retrieve the Jira credentials you will use to connect Jira to Amazon Q. You will also need to add any permissions needed by Jira to connect to Amazon Q. @@ -9,3 +9 @@ Configuring basic authenticationRetrieving project key -Before you connect Jira to Amazon Q, you need to create and retrieve the Jira credentials you will use to connect Jira to Amazon Q. - -The following procedures gives you an overview of how to configure Jira for connecting with Amazon Q. +The following sections give you an overview of how to configure Jira to connect to Amazon Q using either basic authentication or OAuth 2.0 authentication. @@ -15,77 +13 @@ The following procedures gives you an overview of how to configure Jira for conn - * Configuring basic authentication - - * Retrieving project key - - - - -## Configuring basic authentication - -You can connect Amazon Q to Jira using basic authentication credentials. The following procedure gives you an overview of how to configure Jira to connect to Amazon Q using basic authentication. - -###### Configuring Jira basic authentication for Amazon Q - - 1. Sign up for an Atlassian account from [https://atlassian.com/](https://atlassian.com/). Note the email id, including domain, that you logged in with. You will input this later as the Jira ID when you connect to Amazon Q. - - 2. Navigate to Atlassian account from [https://admin.atlassian.com/](https://admin.atlassian.com/). This is where you will configure your Jira instance. - - 3. From the top navigation menu, select **Products**. Then, select **Add product**. - - - - 4. On the **Select product** page, select **Jira Software**. Then, select **Select**. - - - - 5. On the **Add product** page, select **Create new site**. Then, for **Site name** , add a name for your Jira site. Copy the site name, including the domain name. For example: `https://company.atlassian.net/`. You will input this as your **Jira Account URL** when you connect to Amazon Q. - -###### Note - -If you're asked to choose a **Software development** template, choose one based on your use case. - -Select **Agree and add**. - - - - 6. Log in to your Atlassian account from [https://atlassian.com/](https://atlassian.com/). - -Then, from the **Products** menu select **Jira**. - - 7. From the top navigation menu, navigate to **Security**. Then, from **API Tokens** , select **Create and manage API tokens**. - - - - 8. In **API Tokens** , for **Create an API token** , in **Label** , add a label name. Then, select **Create**. - - - - 9. From the **Your new API token** dialog box, copy the API token and save it in a text editor of your choice. You can't retrieve the API token once you close the dialog box. You use the API token to connect Jira to Amazon Q. - - - - - - -You now have the username, Jira URL, and Jira API token you need to connect to Amazon Q with basic authentication. - -For more information, see [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) in Atlassian Support. - -## Retrieving project key - -Amazon Q connector gives you the ability to crawl specific Jira projects instead of crawling all Jira projects. To crawl a specific Jira project, you need to retrieve its **Project Key**. Then, when you connect Jira to Amazon Q, you provide the specific project key you want to crawl in the **Sync scope** section. The following procedure gives you an overview of how to retriever a Jira **Project Key**. - -###### Retrieving a Jira project key - - 1. Log in to your Atlassian account from [https://atlassian.com](https://atlassian.com). - - 2. From the profile top-right navigation menu, choose **My products**. Then choose **Administration**. - - - - 3. From the admin overview page, navigate to your **Jira Software** instance, and then open the settings menu. Select **Open Jira Software**. - - - - 4. From the **Default dashboard page** , from the top navigation menu choose **Projects** , and then select your project. - - 5. On your project page, from the left navigation menu choose **Project settings**. + * [Basic authentication](./jira-credentials-basic.html) @@ -93 +15 @@ Amazon Q connector gives you the ability to crawl specific Jira projects instead - + * [OAuth 2.0 authentication](./jira-credentials-oauth.html) @@ -95 +17 @@ Amazon Q connector gives you the ability to crawl specific Jira projects instead - 6. The **Details** page will display your project key under **Key**. + * [How Amazon Q works with Jira access and refresh tokens](./jira-credentials-notes.html) @@ -97 +19 @@ Amazon Q connector gives you the ability to crawl specific Jira projects instead - + * [Checking Jira connectivity](./jira-connection-check.html) @@ -110 +32 @@ Prerequisites -Using the console +Basic authentication