User Operations
In this article
Overview
Use this Snap to perform the following operations on the users list in your Slack Workspace.
- View User Info
- Add User
- Remove User
Prerequisites
Add valid Slack Scopes based on the intended operation. You must have the owner or administrator privileges to perform some of these operations. See Required Slack Scopes below for details.
Required Slack Scopes
Any action you want to perform within a Slack Workspace, additionally needs appropriate Scopes assigned to your app. See the Scope and Permissions article in Slack API documentation for the complete list and each Account page under Configuring Slack Accounts for information on defining Scopes for your app.
| To | Bot Token Accounts | User Token Accounts ( user_scope) |
|---|---|---|
| View lists of users in the Workspace to select from | users:read | users:read |
| N/A | admin.users:write |
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
- 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.
- User operations Add User and Remove User are admin-specific and cannot be performed using a Bot Token account.
Known Issues
None.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| A document containing information required to perform a specific User operation. |
| Output | Document |
|
| A document containing the result (success/failure) of performing the selected User operation. |
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. | User Operations | User Operations |
| Operation | Drop-down list | Select an operation from the following list of permitted user operations and specify the corresponding details needed:
| User Info | User Info |
| User ID | String/Expression/Suggestion | Required for User Operations. Click the
User ID is used For User Info: To retrieve the user information. For Add User: To add the new user with the corresponding User ID. For Remove User: To delete the user corresponding to the User ID. | N/A | @user.name:W01A94P7MK1 |
| Team ID | String/Expression/Suggestion | Required for User Operations - Add User and Remove User. Click the | N/A | T01BLQ3PNMB |
| Is Restricted | Check box | Required for User operation - Add User. Select this check box to restrict the user's access to only multiple channels. If selected, the user is considered as a guest user with limited access. Do not select this check box if the user should be a Full Member. | Not selected | Selected |
| Is Ultra Restricted | Check box | Required for User operation - Add User. Select this check box to restrict the user's access to a single channel. If selected, the user is considered as a guest user with very limited access. Do not select this check box if the user should be a Full Member. | Not selected | Selected |
| Snap Execution | Drop-down list | Select one of the three following modes in which the Snap executes:
| Execute only | Validate & Execute |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
Unable to suggest workspaces; Reason: missing_scope | You do not have the required permissions to list the users of this Workspace and perform the selected operation. | For except User Operation - User Info, ensure that you have the required admin or owner privileges to perform the operations on users. Also make sure that you have assigned the required Scopes to your Slack app. |
| IO error while validating the given token, Reason: timeout | The Snap connection with your Slack App could not be established due to a timeout error during token validation. | Check you network connectivity, account configuration and retry running/validating your Pipeline/Snap. |
| Failure: Input error, Reason: User ID missing | This Snap does not perform any action in the absence of a valid User ID. | Ensure to provide a valid User ID (typically select from the suggested users list)and save your Snap settings. |
Examples
Retrieving a User's Information and Writing it to a File
This example demonstrates the only user operation that you can perform without admin/owner privileges on your Slack app, that is User Info. using the User Operations Snap. All operations carried out in this example are for demonstration purposes only and the Pipeline reflects the actual/real-time behavior but not the values, either used or retrieved.
We use the User Operations Snap with User Info operation selected, to retrieve the user's information. We also provide the User ID of the user in this Snap. Alternatively, you can select the user from the suggested list of users using the 
icon. The Snap fetches the user's details and presents it in the output (see the following Output).
| User Operations | Output |
|---|---|
|  |
To write the extracted user information into a file for further use, we connect a JSON Formatter Snap and a File Writer Snap, in that order. See the preview of the file we created using the File Writer Snap below.
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Snap Pack History
See Also
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.