AWS quick documentation change
Summary
Complete restructuring of Slack integration documentation, including new authentication methods (Default OAuth, Custom OAuth, Bearer Token), detailed setup instructions, recommended scopes table, available actions list, and troubleshooting guidance.
Security assessment
The changes add comprehensive documentation about authentication methods (including security-focused Custom OAuth and Bearer Token options) and emphasize scope management for least-privilege access. However, there's no evidence of addressing a specific vulnerability or security incident.
Diff
diff --git a/quick/latest/userguide/slack-integration.md b/quick/latest/userguide/slack-integration.md index 677f24ffd..b873ffe76 100644 --- a//quick/latest/userguide/slack-integration.md +++ b//quick/latest/userguide/slack-integration.md @@ -7 +7 @@ -What you can doBefore you beginSet up Slack OAuth appSet up Slack integrationAvailable task actionsShare integrationsManage Slack integrations +Before you beginConfiguring SlackSetting up the connector in Amazon QuickAvailable actionsManaging and troubleshooting @@ -11 +11 @@ What you can doBefore you beginSet up Slack OAuth appSet up Slack integrationAva -With Slack integration in Amazon Quick, you can perform actions within Slack workspaces, including sending messages, managing channels, and interacting with Slack APIs. This integration supports action execution only and requires Amazon Quick Pro tier or higher. +With the Slack action connector, you can access the Slack platform directly in Amazon Quick through natural language. You can send messages, manage channels, search content, and interact with users and user groups without leaving Amazon Quick. @@ -13 +13 @@ With Slack integration in Amazon Quick, you can perform actions within Slack wor -## What you can do +Amazon Quick supports multiple authentication methods for Slack. Choose the method that best fits your organization's security requirements. @@ -15 +15 @@ With Slack integration in Amazon Quick, you can perform actions within Slack wor -With Slack integration, you can perform actions through the action connector. + * **Default OAuth app** – Uses an AWS-managed OAuth application. No additional credentials are needed. You authenticate directly with your Slack workspace. @@ -17 +17 @@ With Slack integration, you can perform actions through the action connector. -**Action connector** + * **Custom OAuth app** – Uses a customer-managed Slack app. This option gives your organization full control over the OAuth configuration. @@ -18,0 +19 @@ With Slack integration, you can perform actions through the action connector. + * **Bearer Token** – Uses a Slack bot token for authentication. This method is suitable for bot-level access to a workspace. @@ -20 +20,0 @@ With Slack integration, you can perform actions through the action connector. -Send messages, manage channels, and access Slack APIs through authenticated connections. @@ -22 +21,0 @@ Send messages, manage channels, and access Slack APIs through authenticated conn -## Before you begin @@ -24 +22,0 @@ Send messages, manage channels, and access Slack APIs through authenticated conn -Before you set up Slack integration, make sure you have the following: @@ -26 +24 @@ Before you set up Slack integration, make sure you have the following: - * Slack workspace with appropriate permissions. +For more information about the authentication methods that Amazon Quick supports, see [Authentication methods](./quick-action-auth.html). @@ -28 +26 @@ Before you set up Slack integration, make sure you have the following: - * Slack app or bot token with required scopes. +## Before you begin @@ -30 +28 @@ Before you set up Slack integration, make sure you have the following: - * Amazon Quick Author or higher. +Make sure that you have the following before you set up the integration. @@ -32 +30 @@ Before you set up Slack integration, make sure you have the following: - * Administrative access to configure OAuth applications (if using user authentication). + * A Slack workspace with access to the channels and data that you want to use. @@ -33,0 +32 @@ Before you set up Slack integration, make sure you have the following: + * For **Custom OAuth app** : Access to the [Slack API dashboard](https://api.slack.com/apps) on the Slack website to create an app. @@ -34,0 +34 @@ Before you set up Slack integration, make sure you have the following: + * For **Bearer Token** : A bot token (starts with `xoxb-`) from a Slack app. For more information, see [Quickstart app settings](https://docs.slack.dev/app-management/quickstart-app-settings) on the Slack website. @@ -35,0 +36 @@ Before you set up Slack integration, make sure you have the following: + * For Amazon Quick subscription requirements, see [Set up integrations in the console](./integration-console-setup-process.html). @@ -37 +37,0 @@ Before you set up Slack integration, make sure you have the following: -## Set up Slack OAuth app @@ -39 +38,0 @@ Before you set up Slack integration, make sure you have the following: -Before you configure the integration, you need to create a Slack app with OAuth capabilities. Follow these steps: @@ -41 +39,0 @@ Before you configure the integration, you need to create a Slack app with OAuth - 1. Go to the Slack API website and create a new Slack app. @@ -43 +41 @@ Before you configure the integration, you need to create a Slack app with OAuth - 2. Configure OAuth scopes based on the actions you want to perform. +## Configuring Slack @@ -45 +43 @@ Before you configure the integration, you need to create a Slack app with OAuth - 3. Set up redirect URLs to match your Amazon Quick integration configuration. +If you are using **Default OAuth app** authentication, skip this section and go to Setting up the connector in Amazon Quick. @@ -47 +45 @@ Before you configure the integration, you need to create a Slack app with OAuth - 4. Note the client ID and client secret for use in Amazon Quick integration setup. +For Custom OAuth app or Bearer Token authentication, complete the applicable steps in Slack before you configure Amazon Quick. @@ -48,0 +47 @@ Before you configure the integration, you need to create a Slack app with OAuth +### Create a Slack app for Custom OAuth app or Bearer Token @@ -49,0 +49 @@ Before you configure the integration, you need to create a Slack app with OAuth +Create a Slack app to get the client credentials or bot token that you need for Amazon Quick. @@ -50,0 +51 @@ Before you configure the integration, you need to create a Slack app with OAuth + 1. Go to the [Slack API dashboard](https://api.slack.com/apps) on the Slack website and choose **Create New App**. @@ -52 +53 @@ Before you configure the integration, you need to create a Slack app with OAuth -## Set up Slack integration + 2. Choose **From scratch**. @@ -54 +55 @@ Before you configure the integration, you need to create a Slack app with OAuth -Use the unified Integrations tab in the Amazon Quick console to set up Slack integration for task execution. Follow these steps: + 3. Enter an **App Name** and select your Slack workspace. Choose **Create App**. @@ -56 +57 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 1. In the Amazon Quick console, choose **Integrations**. + 4. In the left sidebar, choose **OAuth & Permissions**. @@ -58 +59 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 2. Choose **Slack** from the integration options, click the Add (plus "+") button. + 5. Under **Redirect URLs** , choose **Add New Redirect URL** and enter the Amazon Quick callback URL: `https://`{region}`.quicksight.aws.amazon.com/sn/oauthcallback` @@ -60 +61 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 3. Fill in the integration details: +Choose **Add** , then choose **Save URLs**. @@ -62 +63 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Name** \- Descriptive name for your Slack integration. + 6. Under **Scopes** , add the Bot Token Scopes that your integration requires. For the recommended scopes, see Recommended scopes. @@ -64 +65 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Description** (Optional) - Purpose of the integration. + 7. In the left sidebar, choose **Basic Information**. Under **App Credentials** , record the following values: @@ -66 +67 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 4. Choose your connection type (user authentication for Slack). + * **Client ID** @@ -68 +69 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 5. Fill in the connection settings for user authentication: + * **Client secret** @@ -70 +71 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 1. Configure the following OAuth fields: + 8. For **Bearer Token** : Install the app to your workspace from the **OAuth & Permissions** page. After installation, copy the **Bot User OAuth Token** (starts with `xoxb-`). @@ -72 +72,0 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Base URL** \- Slack API base URL (typically https://slack.com/api). @@ -74 +73,0 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Client ID** \- Slack app client ID. @@ -76 +74,0 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Client Secret** \- Slack app client secret. @@ -78 +76 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Token URL** \- Slack OAuth token endpoint. +### Recommended scopes @@ -80 +78 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Auth URL** \- Slack OAuth authorization endpoint. +The following scopes are requested when you connect to Slack. When you create a custom Slack app, add these scopes on the **OAuth & Permissions** page. For Custom OAuth app, add them as **User Token Scopes**. For Bearer Token, add them as **Bot Token Scopes**. @@ -82 +80,43 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - * **Redirect URL** \- OAuth redirect URI configured in your Slack app. +Slack recommended scopes Scope | Description +---|--- +`calls:read` | Reads call information. +`calls:write` | Creates and manages calls. +`channels:history` | Reads message history in public channels. +`channels:read` | Reads information about public channels. +`channels:write` | Manages public channels. +`chat:write` | Sends messages to channels and conversations. +`dnd:read` | Reads Do Not Disturb settings. +`dnd:write` | Updates Do Not Disturb settings. +`emoji:read` | Reads custom emoji. +`files:read` | Reads files shared in channels. +`files:write` | Uploads and manages files. +`groups:history` | Reads message history in private channels. +`groups:read` | Reads information about private channels. +`groups:write` | Manages private channels. +`im:history` | Reads message history in direct messages. +`im:read` | Reads information about direct messages. +`im:write` | Starts direct messages. +`links:read` | Reads link previews. +`links:write` | Manages link previews. +`mpim:history` | Reads message history in group direct messages. +`mpim:read` | Reads information about group direct messages. +`mpim:write` | Starts group direct messages. +`pins:read` | Reads pinned messages. +`pins:write` | Pins and unpins messages. +`reactions:read` | Reads emoji reactions on messages. +`reactions:write` | Adds and removes emoji reactions. +`reminders:read` | Reads reminders. +`reminders:write` | Creates reminders. +`remote_files:read` | Reads remote files. +`remote_files:share` | Shares remote files. +`search:read` | Searches messages and files. +`stars:read` | Reads starred items. +`stars:write` | Stars and unstars items. +`team:read` | Reads workspace information. +`usergroups:read` | Reads user group information. +`usergroups:write` | Manages user groups. +`users:read` | Reads user information. +`users:read.email` | Reads user email addresses. +`users:write` | Updates user information. +`users.profile:read` | Reads user profile information. +`users.profile:write` | Updates user profile information. @@ -84 +124 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 6. Select **Create and continue**. +###### Note @@ -86 +126 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 7. Choose users to share the integration with. +Not all scopes are available for both User Token Scopes and Bot Token Scopes. Some scopes, such as `search:read` and `stars:read`, are available only as User Token Scopes. When you configure scopes for Bearer Token authentication, verify scope availability in the [Slack API scopes reference](https://api.slack.com/scopes) on the Slack website. @@ -88 +128 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int - 8. Click **Next**. +## Setting up the connector in Amazon Quick @@ -89,0 +130 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int +### Connect from the Available tab @@ -90,0 +132 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int +If you want to use Default OAuth app authentication, you can connect directly from the **Available** tab without additional configuration. @@ -91,0 +134 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int + 1. In the Amazon Quick console, choose **Connectors**. @@ -93 +136 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int -## Available task actions + 2. On the **Available** tab, find **Slack** and choose **Connect**. @@ -95 +138 @@ Use the unified Integrations tab in the Amazon Quick console to set up Slack int -After you create your Slack integration, you can review the available actions for interacting with Slack workspaces. Common Slack actions include: + 3. Complete the Slack sign-in flow and grant the requested permissions. @@ -97 +139,0 @@ After you create your Slack integration, you can review the available actions fo - * Send messages to channels or direct messages. @@ -99 +140,0 @@ After you create your Slack integration, you can review the available actions fo - * Create and manage channels. @@ -101 +141,0 @@ After you create your Slack integration, you can review the available actions fo - * Retrieve channel information and member lists. @@ -103 +143 @@ After you create your Slack integration, you can review the available actions fo - * Upload and share files. +To configure a connector with Custom OAuth app or Bearer Token instead, use the **Create for your team** tab as described below. @@ -105 +145 @@ After you create your Slack integration, you can review the available actions fo - * Manage user presence and status. +### Create from the Create for your team tab @@ -107 +147 @@ After you create your Slack integration, you can review the available actions fo - * Access workspace and team information. +After you complete any required Slack configuration, create the connector in Amazon Quick. @@ -108,0 +149 @@ After you create your Slack integration, you can review the available actions fo + 1. In the Amazon Quick console, choose **Connectors**. @@ -109,0 +151 @@ After you create your Slack integration, you can review the available actions fo + 2. Choose the **Create for your team** tab. @@ -110,0 +153 @@ After you create your Slack integration, you can review the available actions fo + 3. Find and choose **Slack**. @@ -114 +157,17 @@ After you create your Slack integration, you can review the available actions fo -The specific actions available depend on the OAuth scopes configured in your Slack app and the permissions granted during authentication. +If a Slack connector already exists, a dialog appears with your existing connectors. To use an existing connector, choose it. To create a new one, choose **No, create new**. + + 4. Enter a **Name** for your connector. Optionally, choose **\+ Add Description** to add a description.