mirror of
https://github.com/suitenumerique/docs
synced 2026-04-21 13:37:20 +00:00
8091cbca23
We want to create a new user in a marketing system to create a dedicated onboarding for each of them. The marketing service is implemented in the django-lasuite library and it is possible to pick the backend we want or implement a new one following the documentation on this library.
79 lines
2.4 KiB
Python
79 lines
2.4 KiB
Python
"""Authentication Backends for the Impress core app."""
|
|
|
|
import logging
|
|
import os
|
|
|
|
from django.conf import settings
|
|
from django.core.exceptions import SuspiciousOperation
|
|
|
|
from lasuite.marketing.tasks import create_or_update_contact
|
|
from lasuite.oidc_login.backends import (
|
|
OIDCAuthenticationBackend as LaSuiteOIDCAuthenticationBackend,
|
|
)
|
|
|
|
from core.models import DuplicateEmailError
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Settings renamed warnings
|
|
if os.environ.get("USER_OIDC_FIELDS_TO_FULLNAME"):
|
|
logger.warning(
|
|
"USER_OIDC_FIELDS_TO_FULLNAME has been renamed to "
|
|
"OIDC_USERINFO_FULLNAME_FIELDS please update your settings."
|
|
)
|
|
|
|
if os.environ.get("USER_OIDC_FIELD_TO_SHORTNAME"):
|
|
logger.warning(
|
|
"USER_OIDC_FIELD_TO_SHORTNAME has been renamed to "
|
|
"OIDC_USERINFO_SHORTNAME_FIELD please update your settings."
|
|
)
|
|
|
|
|
|
class OIDCAuthenticationBackend(LaSuiteOIDCAuthenticationBackend):
|
|
"""Custom OpenID Connect (OIDC) Authentication Backend.
|
|
|
|
This class overrides the default OIDC Authentication Backend to accommodate differences
|
|
in the User and Identity models, and handles signed and/or encrypted UserInfo response.
|
|
"""
|
|
|
|
def get_extra_claims(self, user_info):
|
|
"""
|
|
Return extra claims from user_info.
|
|
|
|
Args:
|
|
user_info (dict): The user information dictionary.
|
|
|
|
Returns:
|
|
dict: A dictionary of extra claims.
|
|
"""
|
|
return {
|
|
"full_name": self.compute_full_name(user_info),
|
|
"short_name": user_info.get(settings.OIDC_USERINFO_SHORTNAME_FIELD),
|
|
}
|
|
|
|
def get_existing_user(self, sub, email):
|
|
"""Fetch existing user by sub or email."""
|
|
|
|
try:
|
|
return self.UserModel.objects.get_user_by_sub_or_email(sub, email)
|
|
except DuplicateEmailError as err:
|
|
raise SuspiciousOperation(err.message) from err
|
|
|
|
def post_get_or_create_user(self, user, claims, is_new_user):
|
|
"""
|
|
Post-processing after user creation or retrieval.
|
|
|
|
Args:
|
|
user (User): The user instance.
|
|
claims (dict): The claims dictionary.
|
|
is_new_user (bool): Indicates if the user was newly created.
|
|
|
|
Returns:
|
|
- None
|
|
|
|
"""
|
|
|
|
if is_new_user and settings.SIGNUP_NEW_USER_TO_MARKETING_EMAIL:
|
|
create_or_update_contact.delay(
|
|
email=user.email, attributes={"DOCS_SOURCE": ["SIGNIN"]}
|
|
)
|