1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
|
=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/>
|