Slack.Web.Apps.Auth.External (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Delete external auth tokens only on the Slack side

Get the access token for the provided token ID

Functions

delete(optional_params \\ %{})

Delete external auth tokens only on the Slack side

API reference

Rate limit: Tier 4: 100+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Optional Params

  • app_id - The id of the app whose tokens you want to delete ex: A12345
  • external_token_id - The id of the token that you want to delete
  • provider_key - The provider key of the provider whose tokens you want to delete

Errors the API can return:

  • app_not_found - The provided app_id was not found
  • invalid_args - The arguments provided to this API are invalid
  • method_not_supported - This API method is not supported
  • no_tokens_found - No tokens found to delete
  • providers_not_found - The provided provider_key is invalid
  • token_not_found - The token pointed to by the external_token_id input is not found
  • unable_to_delete - There was an error deleting tokens

See the Common Errors guide for errors returned by every Web API method.

get(external_token_id, optional_params \\ %{})

Get the access token for the provided token ID

API reference

Rate limit: Tier 3: 50+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • external_token_id - The id of the token you want to get the token for ex: Et12345ABCDE

Optional Params

  • force_refresh - Always refresh existing token before returning even when the token has not expired ex: true

Errors the API can return:

  • access_token_exchange_failed - There was an error while attempting to exchange or refresh token
  • method_not_supported - This API method is not supported
  • no_refresh_token - No refresh token found for the passed external_token_id
  • token_not_found - No token found for the passed external_token_id

See the Common Errors guide for errors returned by every Web API method.