Class: OAuth2::Strategy::Password

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

Overview

The Resource Owner Password Credentials Authorization 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) 


12
13
14
 
# File 'lib/oauth2/strategy/password.rb', line 12

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

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

Retrieve an access token given the specified End User username and password.

Parameters:

  • username (String) —

    the End User username

  • password (String) —

    the End User password

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

    additional params



21
22
23
24
25
26
27
28
 
# File 'lib/oauth2/strategy/password.rb', line 21

def get_token(username, password, params = {}, opts = {})
  params = {
    "grant_type" => "password",
    "username" => username,
    "password" => password,
  }.merge(params)
  @client.get_token(params, opts)
end