=encoding utf8

=head1 NAME

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

=head1 INHERITANCE

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

=head1 SYNOPSIS

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

=head1 DESCRIPTION

Extends L<"DESCRIPTION" in Net::OAuth2::Profile|Net::OAuth2::Profile/"DESCRIPTION">.
 
=head1 METHODS

Extends L<"METHODS" in Net::OAuth2::Profile|Net::OAuth2::Profile/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Net::OAuth2::Profile|Net::OAuth2::Profile/"Constructors">.
 
=over 4

=item Net::OAuth2::Profile::Password-E<gt>B<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>

=over 2

=item client_id => STRING

=item client_secret => STRING

=item grant_type => STRING

=item hd => STRING

=item scope => STRING

=item secrets_in_params => BOOLEAN

=item site => URI

=item state => STRING

=item token_scheme => SCHEME

=item user_agent => LWP::UserAgent object

=back

=back

=head2 Accessors

Extends L<"Accessors" in Net::OAuth2::Profile|Net::OAuth2::Profile/"Accessors">.
 
=over 4

=item $obj-E<gt>B<bearer_token_scheme>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<grant_type>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<hd>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<id>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<scope>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<secret>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<site>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<state>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=item $obj-E<gt>B<user_agent>()

Inherited, see L<Net::OAuth2::Profile/"Accessors">

=back

=head2 Actions

Extends L<"Actions" in Net::OAuth2::Profile|Net::OAuth2::Profile/"Actions">.
 
=head2 Helpers

Extends L<"Helpers" in Net::OAuth2::Profile|Net::OAuth2::Profile/"Helpers">.
 
=over 4

=item $obj-E<gt>B<add_token>($request, $token, $scheme)

Inherited, see L<Net::OAuth2::Profile/"Helpers">

=item $obj-E<gt>B<build_request>($method, $uri, $params)

Inherited, see L<Net::OAuth2::Profile/"Helpers">

=item $obj-E<gt>B<params_from_response>($response, $reason)

Inherited, see L<Net::OAuth2::Profile/"Helpers">

=item $obj-E<gt>B<site_url>( <$uri|$path>, $params )

Inherited, see L<Net::OAuth2::Profile/"Helpers">

=back

=head2 Action

=over 4

=item $obj-E<gt>B<get_access_token>(%options)

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

=over 2

=item password => PASSWORD

=item username => USER

=back

=back

=head1 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 L</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 F<http://dev.perl.org/licenses/>

