Net::OAuth2::AccessToken - OAuth2 bearer token
my $auth = Net::OAuth2::Profile::WebServer->new(...); my $token = $auth->get_access_token($code, ...); # $token is a Net::OAuth2::AccessToken if($token->error) { print $token->error_description; } my $response = $token->get($request); my $response = $token->get($header, $content); print $token->to_string; # JSON # probably better to set new(auto_refresh), but you may do: $token->refresh if $token->expired;
This object represents a received bearer token, and offers ways to use it.
A "bearer token" is an abstract proof of your existence: different services or potentially different physical servers are able to exchange information about your session based on this, for instance whether someone logged-in while showing the token.
-Option --Default access_token undef auto_refresh <false> error undef error_description <value of error> error_uri undef expires_at undef expires_in undef profile <required> refresh_token false scope undef token_type undef
Refresh the token before each use.
Set when an error has occured, the token is not valid. This is not numerical.
A humanly readible explanation on the error. This defaults to the string set with the error option, which is not nice to read.
error
Where to find more details about the error.
Expire this token after TIMESTAMP (as produced by the time() function)
Expire the token SECONDS after the initiation of this object.
Auto-refresh the token at each use.
Returns the (base64 encoded version of the) access token. The token will get updated first, if it has expired and refresh_token is enabled, or when new(auto_refresh) is set.
It does not matter that the token is base64 encoded or not: it will always need to be base64 encoded during transport.
Returns true when the token has an expiration set and that time has passed. We use this token AFTER this check: to avoid the token to timeout inbetween, we take (by default 15 seconds) margin.
Returns the expiration timestamp of this token (true) or undef (false) when it is not set.
undef
Returns the number of seconds left, before the token is expired. That may be negative.
Change the token.
Refresh the token, even if it has not expired yet. Returned is the new access_token value.
Serialize this object into JSON.
This module is part of Net-OAuth2 distribution version 0.50, built on January 07, 2013. Website: http://perl.overmeer.net.
Copyrights 2012-2013 on the perl code and the related documentation by [Mark Overmeer]. For other contributors see Changes.
Copyrights 2011 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
To install Net::OAuth2, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::OAuth2
CPAN shell
perl -MCPAN -e shell install Net::OAuth2
For more information on module installation, please visit the detailed CPAN module installation guide.