AWS amazonq documentation change

Service: amazonq · 2025-07-18 · Documentation low

File: amazonq/latest/qbusiness-ug/confluence-cloud-credentials-oauth.md

Summary

Added detailed documentation about Atlassian Admin Authentication requirements including API key creation, directory ID retrieval, and credential management for Confluence Cloud data sources

Security assessment

Documents proper authentication configuration for admin-level access but does not indicate resolution of a specific security vulnerability. Focuses on security best practices for credential management.

Diff

diff --git a/amazonq/latest/qbusiness-ug/confluence-cloud-credentials-oauth.md b/amazonq/latest/qbusiness-ug/confluence-cloud-credentials-oauth.md
index 9412298a3..4c124e5cc 100644
--- a//amazonq/latest/qbusiness-ug/confluence-cloud-credentials-oauth.md
+++ b//amazonq/latest/qbusiness-ug/confluence-cloud-credentials-oauth.md
@@ -177,0 +178,81 @@ For more information, see [Implementing OAuth 2.0 (3LO)](https://developer.atlas
+### Atlassian Admin Authentication
+
+To ensure Amazon Q can access all user and group information from your Confluence (Cloud) instance, you must provide Atlassian admin credentials. These credentials allow Amazon Q to sync user information regardless of individual email visibility settings.
+
+####  Get your Atlassian admin credentials 
+
+  1. Sign in to the [Atlassian admin portal](https://admin.atlassian.com/)with administrator permissions.
+
+  2. Open the Administration app for your organization. The URL should look like: `https://admin.atlassian.com/o/{ORGANIZATION-UUID}/overview`
+
+  3. Choose **Settings** , then choose **API Keys**.
+
+  4. Choose **Create API key** \
+
+  5. Select all available scopes for the API key. 
+
+Note that the Confluence APIs that fetch user and group information require full scope access.
+
+  6. Copy and save both the **Organization ID** and **API Key**. Note that API keys expire. Monitor the expiration date and update your data source credentials before the key expires. 
+
+
+
+
+####  Get your Directory ID 
+
+  1. Use the Atlassian Admin Workspace API to get your Directory ID. Run the following command:
+    
+        curl --request POST \
+    --url 'https://api.atlassian.com/admin/v2/orgs/{ORGANIZATION-ID}/workspaces' \
+    --header 'Authorization: Bearer {API-KEY}' \
+    --header 'Accept: application/json' \
+    --header 'Content-Type: application/json'
+                                
+
+  2. In the API response, find the workspace entry that matches your Confluence Cloud instance. Look for `"type": "Confluence"`. Verify the workspace name matches your instance and then copy the directory value from the attributes section. If your instance isn't listed, use the pagination cursor in the `links.next` field to view additional pages.
+    
+        curl --request POST \
+    --url 'https://api.atlassian.com/admin/v2/orgs/{ORGANIZATION-ID}/workspaces' \
+    --header 'Authorization: Bearer {API-KEY}' \
+    --header 'Accept: application/json' \
+    --header 'Content-Type: application/json' \
+    --data '{"cursor": "{NEXT-PAGE-TOKEN}"}'
+                                
+
+
+
+
+####  Creating your Confluence data source 
+
+When creating your Confluence Cloud data source, provide these three values in your AWS Secrets Manager secret:
+
+  1. Admin API Key
+
+  2. Organization ID
+
+  3. Directory ID
+
+
+
+
+For more information about Atlassian admin API scopes, see [Atlassian API scopes documentation](https://developer.atlassian.com/cloud/admin/scopes/).
+
+For API details, see [Atlassian Admin Workspace API reference](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-group-workspaces).
+
+####  Updating your Confluence data source 
+
+To update an existing Confluence Cloud data source with new admin credentials, add the following key pairs to your AWS Secrets Manager secret:
+
+  1. adminApiKey, {Admin API Key}
+
+  2. organizationId, {Organization ID}
+
+  3. directoryId, {Directory ID}
+
+
+
+
+For more information about Atlassian admin API scopes, see [Atlassian API scopes documentation](https://developer.atlassian.com/cloud/admin/scopes/).
+
+For API details, see [Atlassian Admin Workspace API reference](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-group-workspaces).
+