Document read.email scope

chargefox · May 17, 2023 · 16739e0 · 16739e0
1 parent a1680bf
commit 16739e0
Showing 1 changed file with 11 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -8,16 +8,17 @@ Right now, the only supported target is Slack: given a list of PageDuty schedule
 
 You will need to create a Slack app with the following scopes:
 
-| Scope              | Optional | Used for                              |
-|--------------------|----------|---------------------------------------|
-| `users:read`       | no       |                                       |
-| `channels:join`    | yes      | joining public channels automatically |
-| `channels:read`    | yes      | managing topics (public channels)     |
-| `channels:manage`  | yes      | managing topics (public channels)     |
-| `groups:read`      | yes      | managing topics (private channels)    |
-| `groups:write`     | yes      | managing topics (private channels)    |
-| `usergroups:read`  | yes      | managing user groups                  |
-| `usergroups:write` | yes      | managing user groups                  |
+| Scope              | Optional | Used for                               |
+|--------------------|----------|----------------------------------------|
+| `users:read`       | no       |                                        |
+| `users:read.email` | yes      | support mapping users by email address |
+| `channels:join`    | yes      | joining public channels automatically  |
+| `channels:read`    | yes      | managing topics (public channels)      |
+| `channels:manage`  | yes      | managing topics (public channels)      |
+| `groups:read`      | yes      | managing topics (private channels)     |
+| `groups:write`     | yes      | managing topics (private channels)     |
+| `usergroups:read`  | yes      | managing user groups                   |
+| `usergroups:write` | yes      | managing user groups                   |
 
 For private channels and when the `channels:join` scope is not assigned, the Slack app needs to be joined to the target channel manually. (One easy to do this is to select the app from a channel where it already exists and use the context menu to add it to another channel.)