slack_web_api v1.2.1 SlackWebAPI.Api.Auth

API calls for all endpoints tagged Auth.

Link to this section Summary

Functions

Checks authentication & identity.

Link to this section Functions

Link to this function

auth_revoke(connection, opts \\ [])

auth_revoke(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Revokes a token.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :test (boolean()): Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
    • :token (String.t): Authentication token. Requires scope: none

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

auth_test(connection, opts \\ [])

auth_test(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Checks authentication & identity.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure