Module: Slack::Web::Api::Endpoints::Oauth

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/oauth.rb

Instance Method Summary collapse

Instance Method Details

#oauth_access(options = {}) ⇒ Object

This method allows you to exchange a temporary OAuth code for an API access token.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :client_id (Object) —

    Issued when you created your application.

  • :client_secret (Object) —

    Issued when you created your application.

  • :code (Object) —

    The code param returned via the OAuth callback.

  • :redirect_uri (Object) —

    This must match the originally submitted URI (if one was sent).

  • :single_channel (Object) —

    Request the user to add your app only to a single channel.

See Also:



23
24
25
26
27
28
 
# File 'lib/slack/web/api/endpoints/oauth.rb', line 23

def oauth_access(options = {})
  throw ArgumentError.new('Required arguments :client_id missing') if options[:client_id].nil?
  throw ArgumentError.new('Required arguments :client_secret missing') if options[:client_secret].nil?
  throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
  post('oauth.access', options)
end

#oauth_token(options = {}) ⇒ Object

This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :client_id (Object) —

    Issued when you created your application.

  • :client_secret (Object) —

    Issued when you created your application.

  • :code (Object) —

    The code param returned via the OAuth callback.

  • :redirect_uri (Object) —

    This must match the originally submitted URI (if one was sent).

  • :single_channel (Object) —

    Request the user to add your app only to a single channel.

See Also:



45
46
47
48
49
50
 
# File 'lib/slack/web/api/endpoints/oauth.rb', line 45

def oauth_token(options = {})
  throw ArgumentError.new('Required arguments :client_id missing') if options[:client_id].nil?
  throw ArgumentError.new('Required arguments :client_secret missing') if options[:client_secret].nil?
  throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
  post('oauth.token', options)
end