Slack. Web. Oauth
(SlackKit v0.25.0-alpha.0)
View Source
Summary
Functions
Exchanges a temporary OAuth verifier code for an access token.
Functions
Exchanges a temporary OAuth verifier code for an access token.
Optional Params
client_id- Issued when you created your application. If possible, avoid sendingclient_idandclient_secretas parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme. If at all possible, avoid sendingclient_idandclient_secretas parameters in your request. ex:2141029472.691202649728client_secret- Issued when you created your application. If possible, avoid sendingclient_idandclient_secretas parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme. If at all possible, avoid sendingclient_idandclient_secretas parameters in your request. ex:e1b9e11dfcd19c1982d5de12921e17e8ccode- Thecodeparam returned via the OAuth callback. ex:4724469134.4644010092847.232b4e6d82c333b475fc30f5f5a341d294feb1a94392c2fd791f7ab7731a443d1aredirect_uri- This must match the originally submitted URI (if one was sent). ex:http://example.comsingle_channel- Request the user to add your app only to a single channel. Only valid with a legacy workspace app. ex:true
Errors the API can return:
token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.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.two_factor_setup_required- Two factor setup is required.invalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.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.deprecated_endpoint- The endpoint has been deprecated.invalid_client_id- Value passed forclient_idwas invalid.oauth_authorization_url_mismatch- The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/authorize.ratelimited- Too many requests made in succession.ekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.missing_resource- Missing permission resource.user_email_unverified- The users email is unverifiedbad_client_secret- Value passed forclient_secretwas invalid.invalid_arguments- The method was called with invalid arguments.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.bad_redirect_uri- Value passed forredirect_uridid not match theredirect_uriin the original request.not_authed- No authentication token provided.internal_error- Something went wrong during app installation.enterprise_is_restricted- The method cannot be called from an Enterprise.no_permission- The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.access_denied- Access to a resource specified in the request is denied.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.missing_scope- The token used is not granted the specific scope permissions required to complete this request.missing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networkinvalid_token- Invalid refresh token.token_expired- Authentication token has expiredinvalid_code- Value passed forcodewas invalid.invalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.method_deprecated- The method has been deprecated.not_allowed_token_type- The token type used in this request is not allowed.org_login_required- The workspace is undergoing an enterprise migration and will not be available until migration is complete.invalid_auth- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.code_already_used- Value passed forcodewas already exchanged.