tornado.auth.OAuth2Mixin Class Reference

Inheritance diagram for tornado.auth.OAuth2Mixin:

List of all members.

Public Member Functions
def	authorize_redirect
Private Member Functions
def	_oauth_request_token_url

---

Detailed Description

Abstract implementation of OAuth 2.0.

See `FacebookGraphMixin` below for an example implementation.

Class attributes:

* ``_OAUTH_AUTHORIZE_URL``: The service's authorization url.
* ``_OAUTH_ACCESS_TOKEN_URL``:  The service's access token url.

Definition at line 565 of file auth.py.

---

Member Function Documentation

def tornado.auth.OAuth2Mixin._oauth_request_token_url	(		self,
			redirect_uri = None,
			client_id = None,
			client_secret = None,
			code = None,
			extra_params = None
	)		[private]

Definition at line 606 of file auth.py.

def tornado.auth.OAuth2Mixin.authorize_redirect	(		self,
			redirect_uri = None,
			client_id = None,
			client_secret = None,
			extra_params = None,
			callback = None,
			scope = None,
			response_type = "code"
	)

Redirects the user to obtain OAuth authorization for this service.

Some providers require that you register a redirect URL with
your application instead of passing one via this method. You
should call this method to log the user in, and then call
``get_authenticated_user`` in the handler for your
redirect URL to complete the authorization process.

.. versionchanged:: 3.1
   Returns a `.Future` and takes an optional callback.  These are
   not strictly necessary as this method is synchronous,
   but they are supplied for consistency with
   `OAuthMixin.authorize_redirect`.

Definition at line 576 of file auth.py.

---

The documentation for this class was generated from the following file:

• auth.py