Django app for City of Helsinki user infrastructure

Installation

First, install the pip package.

pip install django-helusers

Second, implement your own custom User model in your application's models.py.

# users/models.py

from helusers.models import AbstractUser


class User(AbstractUser):
    pass

Then, modify your settings.py to add the helusers app as the first app (or at least before the django.contrib.admin app. You need to also point Django to use your custom User model.

INSTALLED_APPS = (
    ...
    'helusers',
    ...
    'users'
)

AUTH_USER_MODEL = 'users.User'

OAuth2 provider

If you want to use the City's OAuth2 API, you need to install the django-allauth package. Follow the installation instructions provided by django-allauth.

Then, install the allauth provider by adding helusers.providers.helsinki to your INSTALLED_APPS.

After allauth is correctly set up, you need to create a SocialApp instance. You can do it through the Django admin interface (Social Applications). You will be provided the client id and secret key by the City of Helsinki.

You should also make sure allauth doesn't try to send verification emails by including this in your settings.py:

SOCIALACCOUNT_PROVIDERS = {
    'helsinki': {
        'VERIFIED_EMAIL': True
    }
}
SOCIALACCOUNT_ADAPTER = 'helusers.adapter.SocialAccountAdapter'
LOGIN_REDIRECT_URL = '/'
ACCOUNT_LOGOUT_ON_GET = True