Module: Slack::Web::Api::Endpoints::Auth

Included in:

Slack::Web::Api::Endpoints

Defined in:

lib/slack/web/api/endpoints/auth.rb

Instance Method Summary

• #auth_revoke(options = {}) ⇒ Object

  This method revokes an access token.

• #auth_test(options = {}) ⇒ Object

  This method checks authentication and tells you who you are.

Instance Method Details

#auth_revoke(options = {}) ⇒ Object

This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :test (Object) —

  Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.

See Also:

• https://api.slack.com/methods/auth.revoke
• https://github.com/dblock/slack-api-ref/blob/master/methods/auth/auth.revoke.json

# File 'lib/slack/web/api/endpoints/auth.rb', line 15

def auth_revoke(options = {})
  post('auth.revoke', options)
end

#auth_test(options = {}) ⇒ Object

This method checks authentication and tells you who you are.

See Also:

• https://api.slack.com/methods/auth.test
• https://github.com/dblock/slack-api-ref/blob/master/methods/auth/auth.test.json

# File 'lib/slack/web/api/endpoints/auth.rb', line 24

def auth_test(options = {})
  post('auth.test', options)
end