Exchanges a temporary OAuth verifier code for an access token.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/oauth.v2.access
Bolt for Java
app.client().oauthV2Access
Powered by Bolt
Bolt for Python
app.client.oauth_v2_access
Powered by Bolt
Bolt for JavaScript
app.client.oauth.v2.access
Powered by Bolt

Content types

application/x-www-form-urlencoded
  • Rate limits

    Special
  • Arguments

    Optional arguments

    Issued when you created your application. If possible, avoid sending client_id and client_secret as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.

    Example
    2141029472.691202649728

    Issued when you created your application. If possible, avoid sending client_id and client_secret as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.

    Example
    e1b9e11dfcd19c1982d5de12921e17e8c

    The code param returned via the OAuth callback.

    Example
    4724469134.4644010092847.232b4e6d82c333b475fc30f5f5a341d294feb1a94392c2fd791f7ab7731a443d1a

    The grant_type param as described in the OAuth spec.

    Example
    authorization_code

    This must match the originally submitted URI (if one was sent).

    Example
    http://example.com

    The refresh_token param as described in the OAuth spec.

    Example
    xoxe-1-abcdefg

    Usage info

    Keep your tokens secure. Do not share tokens with users or anyone else.

    This is a step in the V2 OAuth authentication flow. Check out our guide to new Slack apps for more information.

    If at all possible, avoid sending client_id and client_secret as parameters in your request. We strongly recommend supplying the Client ID and Client Secret using the HTTP Basic authentication scheme, as discussed in RFC 6749.

    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.

    Look for the is_enterprise_install boolean if your app is an org-ready app and you need to determine whether it has been installed on an entire organization or a single workspace.

    If you're developing a GovSlack app for use by public sector customers, make your API calls to the slack-gov.com domain instead of the slack.com domain.

    Rate limits

    The rate limit for this method is 600 per minute.

    Refresh tokens

    When you use grant_type=refresh_token and pass your refresh_token as an argument, this method refreshes an access token, whether bot or user. Read our guide to token rotation for more information.

    Example responses

    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 token request with scopes for both a bot user and a user token, and token rotation enabled

    {
        "ok": true,
        "access_token": "xoxe.xoxb-1-..",
        "token_type": "bot",
        "scope": "commands,incoming-webhook",
        "bot_user_id": "U0KRQLJ9H",
        "app_id": "A0KRD7HC3",
        "expires_in": 43200,
        "refresh_token": "xoxe-1-...",
        "team": {
            "name": "Slack Softball Team",
            "id": "T9TK3CUKW"
        },
        "enterprise": {
            "name": "slack-sports",
            "id": "E12345678"
        },
        "authed_user": {
            "id": "U1234",
            "scope": "chat:write",
            "access_token": "xoxe.xoxp-1234",
            "expires_in": 43200,
            "refresh_token": "xoxe-1-...",
            "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"
    }

    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.

    ErrorDescription
    bad_client_secret

    Value passed for client_secret was invalid.

    bad_redirect_uri

    Value passed for redirect_uri did not match the redirect_uri in the original request.

    cannot_install_an_org_installed_app

    Returned when the the org-installed app cannot be installed on a workspace.

    invalid_client_id

    Value passed for client_id was invalid.

    invalid_code

    Value passed for code was invalid.

    invalid_grant_type

    Value passed for grant_type was invalid.

    invalid_refresh_token

    The given refresh token is invalid.

    no_scopes

    Missing scope in the request.

    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.

    accesslimited

    Access to this method is limited on the current network

    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.

    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 _. If you get this error, it is typically an indication that you have made a very malformed API call.

    invalid_arguments

    The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.

    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 POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

    invalid_form_data

    The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

    invalid_post_type

    The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

    missing_post_type

    The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    request_timeout

    The method was called via a POST request, but the POST data was either missing or truncated.

    service_unavailable

    The service is temporarily unavailable

    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.

    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.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.