Packages

A Slack Web & Real Time Messaging API client.

Retired package: Renamed - 1.0.0-alpha.0

Current section

Files

Jump to
slack_kit lib slack web docs oauth.v2.access.json
Raw

lib/slack/web/docs/oauth.v2.access.json

{
"args": {
"client_id": {
"desc": "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. If at all possible, avoid sending `client_id` and `client_secret` as parameters in your request.",
"example": "2141029472.691202649728",
"required": false,
"type": "string"
},
"client_secret": {
"desc": "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. If at all possible, avoid sending `client_id` and `client_secret` as parameters in your request.",
"example": "e1b9e11dfcd19c1982d5de12921e17e8c",
"required": false,
"type": "string"
},
"code": {
"desc": "The `code` param returned via the OAuth callback.",
"example": "4724469134.4644010092847.232b4e6d82c333b475fc30f5f5a341d294feb1a94392c2fd791f7ab7731a443d1a",
"required": false,
"type": "string"
},
"code_verifier": {
"desc": "The code\\_verifier param used to generate the code\\_challenge originally. Used for PKCE.",
"example": "secret12345",
"required": false,
"type": "string"
},
"grant_type": {
"desc": "The `grant_type` param as described in the OAuth spec.",
"example": "authorization_code",
"required": false,
"type": "string"
},
"redirect_uri": {
"desc": "This must match the originally submitted URI (if one was sent).",
"example": "http://example.com",
"required": false,
"type": "string"
},
"refresh_token": {
"desc": "The `refresh_token` param as described in the OAuth spec.",
"example": "xoxe-1-abcdefg",
"required": false,
"type": "string"
}
},
"desc": "Exchanges a temporary OAuth verifier code for an access token.",
"errors": {
"access_denied": "Access to a resource specified in the request is denied.",
"accesslimited": "Access to this method is limited on the current network",
"account_inactive": "Authentication token is for a deleted user or workspace when using a `bot` token.",
"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.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"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 called with invalid arguments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"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.",
"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_client_id": "Value passed for `client_id` was invalid.",
"invalid_code": "Value passed for `code` was invalid.",
"invalid_code_verifier": "The code\\_verifier is invalid.",
"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_grant_type": "Value passed for `grant_type` was 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`.",
"invalid_refresh_token": "The given refresh token is invalid.",
"method_deprecated": "The method has been deprecated.",
"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.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"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.",
"no_scopes": "Missing `scope` in the request.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"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.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"pkce_not_allowed": "The app is not allowed to use the PKCE flow.",
"preview_feature_not_available": "Returned when the API method is not yet available on the team in context.",
"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_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"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.",
"token_expired": "Authentication token has expired",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.",
"two_factor_setup_required": "Two factor setup is required.",
"user_email_unverified": "The users email is unverified."
}
}