Class: OAuth2::Strategy::ClientCredentials

Inherits:
Base
  • Object
show all
Defined in:
lib/oauth2/strategy/client_credentials.rb

Overview

The Client Credentials Strategy

See Also:

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from OAuth2::Strategy::Base

Instance Method Details

#authorize_url ⇒ Object

Not used for this strategy

Raises:

  • (NotImplementedError) 


10
11
12
 
# File 'lib/oauth2/strategy/client_credentials.rb', line 10

def authorize_url
  raise(NotImplementedError, 'The authorization endpoint is not used in this strategy')
end

#get_token(params = {}, opts = {}) ⇒ Object

Retrieve an access token given the specified client.

Parameters:

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

    additional params

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

    options



18
19
20
21
 
# File 'lib/oauth2/strategy/client_credentials.rb', line 18

def get_token(params = {}, opts = {})
  params = params.merge('grant_type' => 'client_credentials')
  @client.get_token(params, opts.merge('refresh_token' => nil))
end