oauth.v2.access
Exchanges a temporary OAuth verifier code for an access token.
Facts
Method URL: | https://slack.com/api/oauth.v2.access |
---|---|
Preferred HTTP method: | POST |
Accepted content types: | application/x-www-form-urlencoded |
Rate limiting: | Tier 4 |
This method allows you to exchange a temporary OAuth code
for an API access token.
This is the third step of the V2 OAuth authentication flow. Check out our guide to new Slack apps for more information.
We strongly recommend supplying the Client ID and Client Secret using the HTTP Basic authentication scheme, as discussed in RFC 6749.
If at all possible, avoid sending client_id
and client_secret
as parameters in your request.
Keep your tokens secure. Do not share tokens with users or anyone else.
Arguments
code
The code
param returned via the OAuth callback.
ccdaa72ad
client_id
Issued when you created your application.
Example4b39e9-752c4
client_secret
Issued when you created your application.
Example33fea0113f5b1
redirect_uri
This must match the originally submitted URI (if one was sent).
Examplehttp://example.com
application/x-www-form-urlencoded
querystring or POST body. This method does not currently accept application/json
.
A potential gotcha: while redirect_uri
is optional, it is required if your app passed it as a parameter to oauth/authorization
in the first step of the OAuth flow.
Response
Common successful response
Successful token request with scopes for both a bot user and a user token
{
"ok": true,
"access_token": "xoxb-17653672481-19874698323-pdFZKVeTuE8sk7oOcBrzbqgy",
"token_type": "bot",
"scope": "commands,incoming-webhook",
"bot_user_id": "U0KRQLJ9H",
"app_id": "A0KRD7HC3",
"team": {
"name": "Slack Softball Team",
"id": "T9TK3CUKW"
},
"enterprise": {
"name": "slack-sports",
"id": "E12345678"
},
"authed_user": {
"id": "U1234",
"scope": "chat:write",
"access_token": "xoxp-1234",
"token_type": "user"
}
}
Alternate response
Successful Sign in with Slack response
{
"ok": true,
"app_id": "A0118NQPZZC",
"authed_user": {
"id": "U065VRX1T0",
"scope": "identity.basic,identity.email,identity.avatar,identity.team",
"access_token": "xoxp-yoda-yoda-yoda",
"token_type": "user"
},
"team": {
"id": "T024BE7LD"
},
"enterprise": null,
"is_enterprise_install": false
}
Common error response
Typical error response
{
"ok": false,
"error": "invalid_client_id"
}
Look for the is_enterprise_install
boolean if you're an org-wide app and need to determine whether you've been installed on an entire organization or a single workspace.
Errors
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
invalid_grant_type | Value passed for |
invalid_client_id | Value passed for |
bad_client_secret | Value passed for |
invalid_code | Value passed for |
bad_redirect_uri | Value passed for |
oauth_authorization_url_mismatch | The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/v2/authorize . |
preview_feature_not_available | Returned when the API method is not yet available on the team in context. |
cannot_install_an_org_installed_app | Returned when the the org-installed app cannot be installed on a workspace. |
no_scopes | Missing |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
Warnings
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |