django_helmholtz_aai package

Helmholtz AAI Django App

A generic Django app to login via Helmholtz AAI

Functions:

login(request, user, userinfo)

Login the helmholtz user into django.

django_helmholtz_aai.login(request, user: HelmholtzUser, userinfo: dict[str, Any])

Login the helmholtz user into django.

Notes

Emits the aai_user_logged_in signal

Subpackages

• django_helmholtz_aai.management package
  • Subpackages
    • django_helmholtz_aai.management.commands package
      • Submodules
• django_helmholtz_aai.templatetags package
  • Submodules
    • helmholtz_login_url()
• django_helmholtz_aai.views package
  • Views
  • HelmholtzAuthentificationView
    • HelmholtzAuthentificationView.PermissionDeniedReasons
      • HelmholtzAuthentificationView.PermissionDeniedReasons.cannot_find_user
      • HelmholtzAuthentificationView.PermissionDeniedReasons.email_changed_and_taken
      • HelmholtzAuthentificationView.PermissionDeniedReasons.email_exists
      • HelmholtzAuthentificationView.PermissionDeniedReasons.email_not_verified
      • HelmholtzAuthentificationView.PermissionDeniedReasons.new_user
      • HelmholtzAuthentificationView.PermissionDeniedReasons.vo_not_allowed
    • HelmholtzAuthentificationView.aai_user
    • HelmholtzAuthentificationView.apply_updates()
    • HelmholtzAuthentificationView.as_view()
    • HelmholtzAuthentificationView.create_user()
    • HelmholtzAuthentificationView.create_vo()
    • HelmholtzAuthentificationView.get()
    • HelmholtzAuthentificationView.get_permission_denied_message()
    • HelmholtzAuthentificationView.get_success_url()
    • HelmholtzAuthentificationView.get_user_from_email()
    • HelmholtzAuthentificationView.handle_no_permission()
    • HelmholtzAuthentificationView.has_permission()
    • HelmholtzAuthentificationView.is_new_user
    • HelmholtzAuthentificationView.join_vo()
    • HelmholtzAuthentificationView.leave_vo()
    • HelmholtzAuthentificationView.login_user()
    • HelmholtzAuthentificationView.permission_denied_message_templates
    • HelmholtzAuthentificationView.permission_denied_reason
    • HelmholtzAuthentificationView.synchronize_vos()
    • HelmholtzAuthentificationView.update_user()
    • HelmholtzAuthentificationView.userinfo
  • HelmholtzLoginView
    • HelmholtzLoginView.get()
    • HelmholtzLoginView.post()
  • Subpackages
    • django_helmholtz_aai.views.auth package
      • Authentication viewsets
      • Submodules

Submodules

• Admin interfaces
• HelmholtzAAIUserAdmin
  • HelmholtzAAIUserAdmin.list_display
  • HelmholtzAAIUserAdmin.media
• HelmholtzVirtualOrganizationAdmin
  • HelmholtzVirtualOrganizationAdmin.list_display
  • HelmholtzVirtualOrganizationAdmin.media
  • HelmholtzVirtualOrganizationAdmin.search_fields
  • HelmholtzVirtualOrganizationAdmin.users()
• App settings
• HELMHOLTZ_AAI_CONF_URL
• HELMHOLTZ_ALLOWED_VOS
• HELMHOLTZ_ALLOWED_VOS_REGEXP
• HELMHOLTZ_CLIENT_ID
• HELMHOLTZ_CLIENT_KWS
• HELMHOLTZ_CLIENT_SECRET
• HELMHOLTZ_CREATE_USERS
• HELMHOLTZ_CREATE_USERS_STRATEGY
• HELMHOLTZ_EMAIL_DUPLICATES_ALLOWED
• HELMHOLTZ_MAP_ACCOUNTS
• HELMHOLTZ_UPDATE_EMAIL
• HELMHOLTZ_UPDATE_USERNAME
• HELMHOLTZ_USERNAME_FIELDS
• HELMHOLTZ_USER_BACKEND
• ROOT_URL
• App config
• DjangoHelmholtzAaiConfig
  • DjangoHelmholtzAaiConfig.default_auto_field
  • DjangoHelmholtzAaiConfig.name
• Forms
• MapUserForm
  • MapUserForm.media
  • MapUserForm.save()
• NoDuplicatesUserLinkingForm
  • NoDuplicatesUserLinkingForm.get_users()
  • NoDuplicatesUserLinkingForm.media
• UserLinkingForm
  • UserLinkingForm.__init__()
  • UserLinkingForm.get_users()
  • UserLinkingForm.media
  • UserLinkingForm.save()
  • UserLinkingForm.send_mail()
• Models
• HelmholtzUser
  • HelmholtzUser.DoesNotExist
  • HelmholtzUser.MultipleObjectsReturned
  • HelmholtzUser.eduperson_unique_id
  • HelmholtzUser.is_temporary
  • HelmholtzUser.objects
  • HelmholtzUser.user_ptr
  • HelmholtzUser.user_ptr_id
  • HelmholtzUser.userinfo
• HelmholtzUserManager
  • HelmholtzUserManager.create_aai_user()
  • HelmholtzUserManager.get_or_create_aai_user()
• HelmholtzVirtualOrganization
  • HelmholtzVirtualOrganization.DoesNotExist
  • HelmholtzVirtualOrganization.MultipleObjectsReturned
  • HelmholtzVirtualOrganization.display_name
  • HelmholtzVirtualOrganization.eduperson_entitlement
  • HelmholtzVirtualOrganization.group_ptr
  • HelmholtzVirtualOrganization.group_ptr_id
  • HelmholtzVirtualOrganization.objects
• HelmholtzVirtualOrganizationManager
• HelmholtzVirtualOrganizationQuerySet
  • HelmholtzVirtualOrganizationQuerySet.remove_empty_vos()
• Signals
• aai_user_created
• aai_user_logged_in
• aai_user_updated
• aai_vo_created
• aai_vo_entered
• aai_vo_left
• login_denied
• Token generation algorithm
• UserLinkingTokenGenerator
  • UserLinkingTokenGenerator.algorithm
  • UserLinkingTokenGenerator.check_token()
  • UserLinkingTokenGenerator.key_salt
  • UserLinkingTokenGenerator.make_token()
  • UserLinkingTokenGenerator.secret
  • UserLinkingTokenGenerator.secret_fallbacks
• URL config
• app_name
• urlpatterns