Class OAuth2Decorator

A thread local Credentials object.

Returns:
  A client.Credentials object, or None if credentials hasn't been set in
  this thread yet, which may happen when calling has_credentials inside
  oauth_aware.

A thread local Flow object.

Returns:
  A credentials.Flow object, or None if the flow hasn't been set in this
  thread yet, which happens in _create_flow() since Flows are created
  lazily.

Constructor for OAuth2Decorator

Args:
  client_id: string, client identifier.
  client_secret: string client secret.
  scope: string or iterable of strings, scope(s) of the credentials being
    requested.
  auth_uri: string, URI for authorization endpoint. For convenience
    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
  token_uri: string, URI for token endpoint. For convenience
    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
  revoke_uri: string, URI for revoke endpoint. For convenience
    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
  user_agent: string, User agent of your application, default to None.
  message: Message to display if there are problems with the OAuth 2.0
    configuration. The message may contain HTML and will be presented on the
    web interface for any method that uses the decorator.
  callback_path: string, The absolute path to use as the callback URI. Note
    that this must match up with the URI given when registering the
    application in the APIs Console.
  token_response_param: string. If provided, the full JSON response
    to the access token request will be encoded and included in this query
    parameter in the callback URI. This is useful with providers (e.g.
    wordpress.com) that include extra fields that the client may want.
  _storage_class: "Protected" keyword argument not typically provided to
    this constructor. A storage class to aid in storing a Credentials object
    for a user in the datastore. Defaults to StorageByKeyName.
  _credentials_class: "Protected" keyword argument not typically provided to
    this constructor. A db or ndb Model class to hold credentials. Defaults
    to CredentialsModel.
  _credentials_property_name: "Protected" keyword argument not typically
    provided to this constructor. A string indicating the name of the field
    on the _credentials_class where a Credentials object will be stored.
    Defaults to 'credentials'.
  **kwargs: dict, Keyword arguments are be passed along as kwargs to the
    OAuth2WebServerFlow constructor.

Decorators:

• @util.positional(4)

Overrides: object.__init__

Decorator that starts the OAuth 2.0 dance.

Starts the OAuth dance for the logged in user if they haven't already
granted access for this application.

Args:
  method: callable, to be decorated method of a webapp.RequestHandler
    instance.

Decorator that sets up for OAuth 2.0 dance, but doesn't do it.

Does all the setup for the OAuth dance, but doesn't initiate it.
This decorator is useful if you want to create a page that knows
whether or not the user has granted access to this application.
From within a method decorated with @oauth_aware the has_credentials()
and authorize_url() methods can be called.

Args:
  method: callable, to be decorated method of a webapp.RequestHandler
    instance.

True if for the logged in user there are valid access Credentials.

Must only be called from with a webapp.RequestHandler subclassed method
that had been decorated with either @oauth_required or @oauth_aware.

Returns the URL to start the OAuth dance.

Must only be called from with a webapp.RequestHandler subclassed method
that had been decorated with either @oauth_required or @oauth_aware.

Returns an authorized http instance.

Must only be called from within an @oauth_required decorated method, or
from within an @oauth_aware decorated method where has_credentials()
returns True.

The absolute path where the callback will occur.

Note this is the absolute path, not the absolute URI, that will be
calculated by the decorator at runtime. See callback_handler() for how this
should be used.

Returns:
  The callback path as a string.

Decorators:

• @property

RequestHandler for the OAuth 2.0 redirect callback.

Usage:
   app = webapp.WSGIApplication([
     ('/index', MyIndexHandler),
     ...,
     (decorator.callback_path, decorator.callback_handler())
   ])

Returns:
  A webapp.RequestHandler that handles the redirect back from the
  server during the OAuth 2.0 dance.

WSGI application for handling the OAuth 2.0 redirect callback.

If you need finer grained control use `callback_handler` which returns just
the webapp.RequestHandler.

Returns:
  A webapp.WSGIApplication that handles the redirect back from the
  server during the OAuth 2.0 dance.