NAME

Net::OAuth2::Profile::Password - OAuth2 for web-server use

INHERITANCE

 Net::OAuth2::Profile::Password
   is a Net::OAuth2::Profile

SYNOPSIS

  my $auth = Net::OAuth2::Profile::Password->new(...);
  $auth->get_access_token(...);

METHODS

Constructors

Net::OAuth2::Profile::Password->new(OPTIONS)

 -Option       --Defined in          --Default
  client_id      Net::OAuth2::Profile  <required>
  client_secret  Net::OAuth2::Profile  <required>
  grant_type     Net::OAuth2::Profile  'password'
  scope          Net::OAuth2::Profile  undef
  site           Net::OAuth2::Profile  undef
  token_scheme   Net::OAuth2::Profile  'auth-header:OAuth'
  user_agent     Net::OAuth2::Profile  <created internally>

client_id => STRING
client_secret => STRING
grant_type => STRING
scope => STRING
site => URI
token_scheme => SCHEME
user_agent => LWP::UserAgent object

Accessors

$obj->bearer_token_scheme(): See "Accessors" in Net::OAuth2::Profile
$obj->grant_type(): See "Accessors" in Net::OAuth2::Profile
$obj->id(): See "Accessors" in Net::OAuth2::Profile
$obj->scope(): See "Accessors" in Net::OAuth2::Profile
$obj->secret(): See "Accessors" in Net::OAuth2::Profile
$obj->site(): See "Accessors" in Net::OAuth2::Profile
$obj->user_agent(): See "Accessors" in Net::OAuth2::Profile

Actions

HTTP

$obj->request(REQUEST, [MORE]): See "HTTP" in Net::OAuth2::Profile
$obj->request_auth(TOKEN, (REQUEST | (METHOD, URI, [HEADER, CONTENT]))): See "HTTP" in Net::OAuth2::Profile

Helpers

$obj->add_token(REQUEST, TOKEN, SCHEME): See "Helpers" in Net::OAuth2::Profile
$obj->build_request(METHOD, URI, PARAMS): See "Helpers" in Net::OAuth2::Profile
$obj->params_from_response(RESPONSE, REASON): See "Helpers" in Net::OAuth2::Profile
$obj->site_url((URI|PATH), PARAMS): See "Helpers" in Net::OAuth2::Profile

Action

$obj->get_access_token(OPTIONS)

 -Option  --Default
  password  <required>
  username  <required>

password => PASSWORD
username => USER

COPYRIGHTS

Copyrights 2013 on the perl code and the related documentation by [Mark Overmeer] for SURFnet bv, The Netherlands. For other contributors see Changes.

Copyrights 2011-12 by Keith Grennan.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

CPAN RT