Skip to main content

OAuth 2.0 authentication for Google and Google Apps accounts

Project description

Simplified OAuth + OpenID Connect for authentication via Google.

googleauth used to be REALLY simple, but then Google decided to get rid of their OpenID service. Boooo Google. googleauth has been migrated to OAuth 2.0 + OpenID Connect, which isn’t quite as great because it takes a bit more configuration to get going.

googleauth was built to provide an easy way to add authentication against a Google Apps for Business domain, ideally for an individual organization. This package is not the best option if you are looking for a general social auth solution. Check out python-social-auth instead.

Getting things set up on Google

  1. Log in to the Google API Console.

  2. Open an existing project or create a new one if needed.

  3. Under the APIS & AUTH menu item, click APIs.

  4. Turn on the Google+ API.

  5. Under the APIS & AUTH menu item, click Credentials.

  6. Click the Create new Client ID button.

  7. Select Web application for application type, add your domain as the JavaScript origin, and add the full domain and path to the OAuth callback (see below for how to find this URL). Click the Create Client ID button to finish.

  8. You’re going to need the Client ID and Client secret values in Django settings, so keep this window open or copy them for later.

Callback URL

The callback URL is constructed from your preferred URL scheme, the domain at which your site is hosted, and the path where you mount the googleauth URL config in Django.

Let’s assume you are using HTTPS and have mounted the googleauth URL config at the root URL. Your callback URL would look something like:


Okay, now let’s assume you are using HTTP and have mounted the googleauth URL config under /accounts/:


Django Setup

Settings and configuration

The following settings should be placed in





Required settings:

# client ID from the Google Developer Console

# client secret from the Google Developer Console

# your app's domain, used to construct callback URLs

Optional settings:

# callback URL uses HTTPS (your side, not Google), default True

# restrict to the given Google Apps domain, default None

# get user's name, default True (extra HTTP request)

# sets value of user.is_staff for new users, default False

# list of default group names to assign to new users

URL routes

Add URL config:

urlpatterns = patterns('',
    (r'^auth/', include('googleauth.urls')),

googleauth doesn’t need to be mounted under /auth/, it can go anywhere. Place it where you see fit for your specific app.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-googleauth-2.1.tar.gz (4.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page