Class AccessTokenCredentials

source code

Credentials object for OAuth 2.0.

Credentials can be applied to an httplib2.Http object using the
authorize() method, which then signs each request from that object
with the OAuth 2.0 access token. This set of credentials is for the
use case where you have acquired an OAuth 2.0 access_token from
another place such as a JavaScript client or another web
application, and wish to use it from Python. Because only the
access_token is present it can not be refreshed and will in time
expire.

AccessTokenCredentials objects may be safely pickled and unpickled.

Usage:
  credentials = AccessTokenCredentials('<an access token>',
    'my-user-agent/1.0')
  http = httplib2.Http()
  http = credentials.authorize(http)

Exceptions:
  AccessTokenCredentialsExpired: raised when the access_token expires or is
    revoked.

Create an instance of OAuth2Credentials

This is one of the few types if Credentials that you should contrust,
Credentials objects are usually instantiated by a Flow.

Args:
  access_token: string, access token.
  user_agent: string, The HTTP User-Agent to provide for this application.
  revoke_uri: string, URI for revoke endpoint. Defaults to None; a token
    can't be revoked if this is None.

Instantiate a Credentials object from a JSON description of it. The JSON
should have been produced by calling .to_json() on the object.

Args:
  data: dict, A deserialized JSON object.

Returns:
  An instance of a Credentials subclass.

Refreshes the access_token.

This method first checks by reading the Storage object if available.
If a refresh is still needed, it holds the Storage lock until the
refresh is completed.

Args:
  http_request: callable, a callable that matches the method signature of
    httplib2.Http.request, used to make the refresh request.

Raises:
  AccessTokenRefreshError: When the refresh fails.

Revokes the access_token and deletes the store if available.

Args:
  http_request: callable, a callable that matches the method signature of
    httplib2.Http.request, used to make the revoke request.