Module: Slack::Endpoint::Auth

Included in:

Slack::Endpoint

Defined in:

lib/slack/endpoint/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/aki017/slack-api-docs/blob/master/methods/auth.revoke.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/auth.revoke.json

# File 'lib/slack/endpoint/auth.rb', line 14

def auth_revoke(options={})
  options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
  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/aki017/slack-api-docs/blob/master/methods/auth.test.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/auth.test.json

# File 'lib/slack/endpoint/auth.rb', line 25

def auth_test(options={})
  options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
  post("auth.test", options)
end