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(...);

DESCRIPTION

Extends "DESCRIPTION" in Net::OAuth2::Profile.

METHODS

Extends "METHODS" in Net::OAuth2::Profile.

Constructors

Extends "Constructors" in Net::OAuth2::Profile.

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'
  hd                 Net::OAuth2::Profile  undef
  scope              Net::OAuth2::Profile  undef
  secrets_in_params  Net::OAuth2::Profile  <true>
  site               Net::OAuth2::Profile  undef
  state              Net::OAuth2::Profile  undef
  token_scheme       Net::OAuth2::Profile  'auth-header:Bearer'
  user_agent         Net::OAuth2::Profile  <created internally>

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

Accessors

Extends "Accessors" in Net::OAuth2::Profile.

$obj->bearer_token_scheme(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->grant_type(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->hd(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->id(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->scope(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->secret(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->site(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->state(): Inherited, see "Accessors" in Net::OAuth2::Profile
$obj->user_agent(): Inherited, see "Accessors" in Net::OAuth2::Profile

Actions

Extends "Actions" in Net::OAuth2::Profile.

Helpers

Extends "Helpers" in Net::OAuth2::Profile.

$obj->add_token($request, $token, $scheme): Inherited, see "Helpers" in Net::OAuth2::Profile
$obj->build_request($method, $uri, $params): Inherited, see "Helpers" in Net::OAuth2::Profile
$obj->params_from_response($response, $reason): Inherited, see "Helpers" in Net::OAuth2::Profile
$obj->site_url( <$uri|$path>, $params ): Inherited, 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-2019 on the perl code and the related documentation
by [Mark Overmeer <markov@cpan.org>] for SURFnet bv, The Netherlands. For other contributors see "Changes".

Copyrights 2011-2012 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://dev.perl.org/licenses/

2021-10-15

perl v5.32.1