In this article

Overview

Use this Snap to perform the following Workspace operations.

Workspace Info
Create Workspace
List Workspaces
List Channels
List Users
Delete Channel

Prerequisites

A valid and active account in the Slack Workspace. You must have the owner or administrator privileges to perform some of these operations.

Slack Scopes required

Any action you want to perform within a Slack Workspace, additionally needs appropriate Scopes assigned to your app. See Scopes for more information.

To	Bot Token Accounts (`scope`)	User Token Accounts (`user_scope`)
Workspace Info	N/A	`admin.teams:read`
Create Workspace	N/A	`admin.teams:write`
List Workspaces	N/A	`admin.teams:read`
List Channels in a Workspace	N/A	`admin.usergroups:read`
List Users in a Workspace	`N/A`	`admin.users:read`
Delete Channel	N/A	`admin.usergroups:write OR admin.conversations:write OR` `admin.users:write`

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

Workspace operations work with User Tokens only. Do not use Bot Token Account with this Snap.
Snaps in this Snap Pack use conditional display/hiding of fields. So, ensure that you always use the New Form UI (and not the classic UI) for the Snaps to function as designed/expected.

Known Issues

This Snap is not tested with admin credentials against an Enterprise-oriented Slack installation and this document does not deal with these features in detail.

Snap Input and Output

Input/Output	Type of View	Number of Views	Examples of Upstream and Downstream Snaps	Description
Input	Document	Min: 0 Max: 1	Mapper Copy JSON Generator	A document with an input to perform one of the Workspace operations.
Output	Document	Min: 1 Max: 1	Mapper JSON Formatter Filter	A document containing the output records or result (success/failure) based on the operation performed.

Snap Settings

Parameter Name

Data Type

Description

Default Value

Example

Label

String

Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Workspace Operations

Operation

Drop-down list

Select an operation from the following list of permitted workspace operations and specify the corresponding details needed:

Workspace Info. To fetch information about settings in a Workspace.
Create Workspace. To create an Enterprise Team/Workspace. Also, specify the details for the new Team/Workspace. Needs Admin permissions for the Enterprise Grid.
List Workspaces. To list all Teams/Workspaces on an Enterprise/organization. Needs Admin permissions for the Enterprise Grid.
List Channels. To list all Channels within the Enterprise/organization
List Users. To list all the users in the Enterprise/organization.
Delete Channel. To delete a channel in the Enterprise/organization. Needs Admin permissions for the Enterprise Grid.

Workspace Info

Create Workspace

Snap Execution

Drop-down list

Select one of the three following modes in which the Snap executes:

Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
Disabled. Disables the Snap and all Snaps downstream from it.

Execute only

Validate & Execute

Troubleshooting

Error

Reason

Resolution

Unable to list all the workspaces. missing_scope

The token corresponds to an individual (non-Enterprise Grid) installation and hence not authorized to perform this Admin operation.

OR

The token associated with your Snap account does not have the required Slack Scope assigned.

If the Snap account/token is related to an individual installation of Slack, you cannot perform this operation.

For Enterprise Grids, ensure that the token, and hence the account, have the required Slack Scope assigned as mentioned in the Prerequisites section.

You must re-install the Slack application for the new Scope assignments to take effect.

Examples

Extracting the list of non-Admin users in the Workspace

This example demonstrates how we can use the Workspace Operations Snap to extract/prepare a list of users in the Workspace that do not have admin privileges.

Firstly, we select List Users as the Operation in Workspace Operations Snap. This Snap does not need any other input and generates the list of all users added to the Workspace.

Workspace Operations Snap

Output

Now, we connect a Filter Snap to extract only the users who do not have admin privileges using the Filter expression $is_admin == False. This Snap yields the following output.

Filter Snap

Output

With this information at hand, we now connect a Mapper Snap to the Filter Snap to extract the user details we want to populate for each non-Admin user. This example showcases three fields - $id as id, $real_name as Name, and the result of an expression $is_admin == true?"Admin user":"Not Admin user" as Admin? for each non-Admin user in the list. You can map and extract as many fields as available for each user record in the Filter Snap's output.

Mapper Snap

Output

To save the extracted data as a file, you can choose to format this data using any Formatter Snap and write the output into a file (JSON, CSV, and so on) using the File Writer.

Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.

	File	Modified

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.

No files shared here yet.

Drag and drop to upload or browse for files

Error rendering macro 'excerpt-include' : No link could be created for 'Slack Snap Pack (Doc in Progress)'.

Workspace Operations (Doc in Progress)