|Read this if:||You want to share and distribute your app.|
|Read first:||Using OAuth 2.0|
|Read next:||Safely Storing Credentials|
OAuth scopes let you specify exactly how your app needs to access a Slack user's account. As an app developer, you specify your desired scopes in the initial OAuth authorization request. When a user is responding to your OAuth request, the requested scopes will be displayed to them when they are asked to approve your request.
Slack uses scopes that refer to the object they grant access to, followed by the class of actions on that object they allow (e.g.
file:write). Additionally, some scopes have an optional perspective which is either
admin, which influences how the action appears in Slack (e.g.
chat:write:user will send a message from the authorizing user as opposed to your app).
The list of objects includes
reactions, along with many other objects in Slack.
There are currently only three classes of action:
For example, to request access to the list of channels on a workspace and the ability to send messages to those channels as a bot, your app would request
Learn even more detail about these OAuth scopes here.
|OAuth Scope||Associated Methods|
If you're building a Slack app, you will also encounter three other scopes.
incoming-webhook- requesting this scope during the authentication process allows workspaces to easily install an incoming webhook that can post from your app to a single Slack channel.
commands- similarly, requesting this scope allows workspaces to install slash commands bundled in your Slack app.
bot- request this scope when your Slack app includes bot user functionality. Unlike
botscope grants your bot user access to a subset of Web API methods, the RTM API, and certain event types in the Events API.
Additionally, Slack supports the following special scopes:
When making the initial authorization request, your application can request multiple scopes as a space or comma separated list (e.g.
https://slack.com/oauth/authorize? client_id=...& scope=team%3Aread+users%3Aread
When using the Slack API you can check the HTTP headers to see what OAuth scopes you have, and what the API method accepts.
$ curl https://slack.com/api/files.list?token=abcd -I HTTP/1.1 200 OK X-OAuth-Scopes: files:read, chat:write:bot X-Accepted-OAuth-Scopes: files:read
X-OAuth-Scopes lists the scopes your token has authorized.
X-Accepted-OAuth-Scopes lists the scopes that the action checks for.
Please note that certain scopes cannot be asked for in combination with each other. For instance, you cannot request both the
bot scope and the
client scope. When users arrive at an authorization page requesting invalid scope combinations, they'll see an ugly error stating something to this effect:
"OAuth error: invalid_scope: Cannot request service scope (bot) with deprecated scopes"
The following scopes are deprecated and their use is strongly discouraged: