Troubleshooting Guide

Common questions:

Admin Message: State Mismatched. Time expired?

This error occurs when the user is redirected to the Google login page and then returns to the Django login page but original state are not found. Please check if the browser has the anonymous session created by Django. This error can occur if you use 127.0.0.1 instead of localhost for your local tests.

Google show the message: The Solicitation from App XXX is Invalid.

Make sure you have added the correct Callback URI on Google Console. Please remember the trailing slash for this URI.

My custom css is not working

Make sure you have added the correct static files path on your settings.py file. Please check the Django documentation for more details. Make sure your path is static/django_google_sso/google_button.css. You can also need to setup the STATICFILES_DIRS setting in your project. Check the Example app below for more details.

How can I log out Django user if I log out from Google first?

If you log out from Google, the Django user will not be logged out automatically - his user session is valid up to 1 hour, or the time defined, in seconds, in GOOGLE_SSO_SESSION_COOKIE_AGE. You can use the GOOGLE_SSO_SAVE_ACCESS_TOKEN to save the access token generated during user login, and use it to check if the user status in Google (inside a Middleware, for example). Please check the Example App for more details.

My callback URL is http://example.com/google_sso/callback/ but my project is running at http://localhost:8000

This error occurs because your Project is using the Django Sites Framework and the current site is not configured correctly. Please make sure that the current site is configured for your needs or, alternatively, use the GOOGLE_SSO_CALLBACK_DOMAIN setting.

There's too much information on logs and messages from this app.

You can disable the logs using the GOOGLE_SSO_ENABLE_LOGS setting and the messages using the GOOGLE_SSO_ENABLE_MESSAGES setting.

System goes looping to admin after login.

This is because the user data was received from Google, but the user was not created in the database or is not active. To see these errors please check the logs or enable the option GOOGLE_SSO_SHOW_FAILED_LOGIN_MESSAGE to see failed login messages on browser. Please, make note these messages can be used on exploit attacks.

Got a "KeyError: 'NAME'" error after set SSO_USE_ALTERNATE_W003

If you get a KeyError: 'NAME' error, please set a NAME in TEMPLATES at settings.py:

# settings.py

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "NAME" : "default",  # <-- Add name here
        "DIRS": [BASE_DIR / "templates"],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
                "django.template.context_processors.debug",
                "django.template.context_processors.request",
                "django.contrib.auth.context_processors.auth",
                "django.contrib.messages.context_processors.messages",
            ],
        },
    },
]

Got this error when migrating: 'The model User is already registered with 'core.GoogleSSOUserAdmin'

This is because you're already define a custom User model and admin in your project. You need to extended the existing user model unregistering your current User Admin class and add manually the GoogleSSOInlineAdmin in your custom class. You can use the get_current_user_and_admin helper as explained here (the recommended action), or alternately, you can add the django-google-sso at the end of your INSTALLED_APPS list.

Example App

To test this library please check the Example App provided here.

Not working?

Don't panic. Get a towel and, please, open an issue.