Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods oauth.v2.user.access.json
Raw

priv/docs/methods/oauth.v2.user.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.",
"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.",
"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 a user access token.",
"errors": {
"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.",
"no_user_scopes": "Missing user `scope` in the auth request.",
"not_implemented": "Method not yet supported",
"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.",
"user_email_unverified": "The users email is unverified"
},
"rate_limit": {
"label": "Special rate limits apply.",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {}
}