You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
# Python-Slack-Discovery-SDK
2
2
3
-
👋🏼 Welcome to the Python-Slack-Discovery-SDK! This project aims to make using the [Slack Discovery API's](https://api.slack.com/enterprise/discovery/methods#methods) easier.
3
+
👋🏼 Welcome to the Python-Slack-Discovery-SDK! This project aims to make using the Slack Discovery APIs easier.
4
4
5
5
> 🚨 Note: This SDK is only accessible to customer developers with access to the Discovery API (Enterprise accounts) or partners who have been onboarded to the Security and Compliance partner program. To learn more about the Discovery APIs, please [visit our help center](https://slack.com/help/articles/360002079527-A-guide-to-Slacks-Discovery-APIs). 🚨
6
6
7
-
8
7
# Using the SDK
9
8
10
9
Below are the steps needed to use the Discovery SDK.
@@ -14,7 +13,7 @@ Below are the steps needed to use the Discovery SDK.
14
13
In order to speed up the development process, we've provided you with a script called
15
14
`set_env_vars.sh` in the scripts folder to automate a few things needed to run the SDK.
16
15
The script accomplishes the following things using the following code:
17
-
* Prints your current Python version (<b>you will need Python version 3.6 or greater for this SDK</b>)
16
+
* Prints your current Python version (**you will need Python version 3.6 or greater for this SDK**)
18
17
```bash
19
18
python3 --version
20
19
```
@@ -37,7 +36,7 @@ The script accomplishes the following things using the following code:
37
36
🚨 At this point, you'll need to edit the `scripts/set_env_vars.sh` script in an editor of your choice 🚨
38
37
39
38
Edit the line below, and add in your token with `discovery:read` and `discovery:write` scopes.
@@ -128,24 +127,23 @@ you should see debug output in your terminal once the script has finished runnin
128
127
129
128
Continue reading below to learn what each example does:
130
129
131
-
💳 <b>`DLP_call_pattern.py`</b> 💳
130
+
💳 **`DLP_call_pattern.py`** 💳
132
131
* This script involves using the tombstoning capabilities of the Discovery SDK to check for messages that contain sensitive information. If sensitive information is detected by our script (for example a credit card number), the message is tombstoned, and the user is notified that their message is being reviewed.
133
132
* Once you run this script, you should see that one of your
134
133
messages in the channel which you setin your env variable (SLACK_DISCOVERY_SDK_TEST_CHANNEL_ID) should have been tombstoned. The message should now say `This message is being scanned to make sure it complies with your team’s data security policies.`
* This script retrieves all of the conversations (channels) and messages a particular user is in. It then outputs those
138
137
conversations to a file, and stores them in the following format: `YYYY/MM/DD/user_id/channel_id/discovery_conversations.json`. If the `has_edits` flag is true
139
-
fora certain conversation, all edited messages will be foundin the `edits` field.
140
-
138
+
fora certain conversation, all edited messages will be foundin the `edits` field.
141
139
142
-
👩🏻🏫 <b>`audit_logs_pattern.py`</b> 👩🏻🏫
140
+
👩🏻🏫 **`audit_logs_pattern.py`** 👩🏻🏫
143
141
* This script will use the [Audit Logs API](https://api.slack.com/admins/audit-logs) to find all of the
144
142
channels that a particular user has created. As is the
145
143
case with the `user_based_eDiscovery` script, it will only
146
144
be useful if you have a paricular user which you want to see details about. This script will output the channel creation events associated with a particular user_id to in the following format: `YYYY/MM/DD/user_id/audit_logs/public_channel_created.json`.
0 commit comments