steampipe plugin install slacksteampipe plugin install slack

Slack + Steampipe

Slack is a messaging program designed specifically for the workplace.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

For example:

select
  email,
  is_admin
from
  slack_user;

+-----------------+----------+
| email|          | is_admin |
+-----------------+----------+
| pam@dmi.com     | false    |
| creed@dmi.com   | true     |
| stanley@dmi.com | false    |
| michael@dmi.com | true     |
| dwight@dmi.com  | false    |
+-----------------+----------+

Documentation

Table definitions & examples →

Get started

Install

Download and install the latest Slack plugin:

steampipe plugin install slack

Credentials

API tokens in Slack are associated with Apps. To use Steampipe, you need to create an App in Slack with the appropriate permissions.

Sign in to the Slack website, and view "Your Apps" at https://api.slack.com/apps.
Select Create New App.
Select From scratch.
Enter an application name, e.g., Steampipe CLI, and select your workspace.
Select Add features & functionality.
Select Permissions.
Scroll down to "Scopes" and then "User Token Scopes".
Add permissions by scope, using the table below to grant the required read access.
Scroll up to "OAuth Tokens for Your Workspace" and (re)install your app.
Copy the user OAuth token for the application. It looks like xoxp-2556146250-EXAMPLE-1646968370949-df954218b5da5b8614c85cc454136b27.

Permissions and Scopes

Scopes are used to determine the permissions and access granted to your App in Slack. Steampipe requires different permissions for each table. We recommend granting the team:read scope and all of the scopes in the table below, but you can restrict them to specific tables if you prefer.

Please note that if you add scopes to an application, you will need to reinstall the application to the workspace for the changes to take effect.

Table	Scopes Required
All tables	`team:read` (if querying the `workspace_domain` column)
`slack_access_log`	`admin` (paid plan required)
`slack_connection`	None
`slack_conversation`	`channels:read`, `groups:read`, `im:read`, `mpim:read`
`slack_conversation_member`	`channels:read`, `groups:read`, `im:read`, `mpim:read`
`slack_emoji`	`emoji:read`
`slack_group`	`usergroups:read`
`slack_search`	`search:read`
`slack_user`	`users:read`, `users:read.email`

Configuration

Installing the latest slack plugin will create a config file (~/.steampipe/config/slack.spc) with a single connection named slack:

connection "slack" {
  plugin = "slack"

  # The Slack app token used to connect to the API.
  # Can also be set with the SLACK_TOKEN environment variable.
  #token = "xoxp-YOUR_TOKEN_HERE"
}

Get involved

Open source: https://github.com/turbot/steampipe-plugin-slack
Community: Slack Channel

turbot/slack