Method: OAuth2::Client#get_token

Defined in:

lib/oauth2/client.rb

#get_token(params, access_token_opts = {}, extract_access_token = nil) {|opts| ... } ⇒ AccessToken^?

Note:

The extract_access_token parameter is deprecated and will be removed in oauth2 v3. Use access_token_class on initialization instead.

Retrieves an access token from the token endpoint using the specified parameters

Examples:

client.get_token(
  'grant_type' => 'authorization_code',
  'code' => 'auth_code_value',
  'headers' => {'Authorization' => 'Basic ...'}
)

Parameters:

• params (Hash) —

  a Hash of params for the token endpoint

  • params can include a ‘headers’ key with a Hash of request headers

  • params can include a ‘parse’ key with the Symbol name of response parsing strategy (default: :automatic)

  • params can include a ‘snaky’ key to control snake_case conversion (default: false)

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

  options that will be passed to the AccessToken initialization

• extract_access_token (Proc) (defaults to: nil) —

  (deprecated) a proc that can extract the access token from the response

Yields:

• (opts) —

  The block is passed the options being used to make the request

Yield Parameters:

• opts (Hash) —

  options being passed to the http library

Returns:

• (AccessToken, nil) —

  the initialized AccessToken instance, or nil if token extraction fails and raise_errors is false

# File 'lib/oauth2/client.rb', line 208

def get_token(params, access_token_opts = {}, extract_access_token = nil, &block)
  warn("OAuth2::Client#get_token argument `extract_access_token` will be removed in oauth2 v3. Refactor to use `access_token_class` on #initialize.") if extract_access_token
  extract_access_token ||= options[:extract_access_token]
  req_opts = params_to_req_opts(params)
  response = request(http_method, token_url, req_opts, &block)

  # In v1.4.x, the deprecated extract_access_token option retrieves the token from the response.
  # We preserve this behavior here, but a custom access_token_class that implements #from_hash
  # should be used instead.
  if extract_access_token
    parse_response_legacy(response, access_token_opts, extract_access_token)
  else
    parse_response(response, access_token_opts)
  end
end