django-helmholtz-aai
v0.2.0

Contents:

  • Installation
    • Installation from PyPi
    • Register your OAuth-Client at the Helmholtz AAI
    • Install the Django App for your project
    • Installation for development
    • References
  • Configuration options
    • Configuration settings
      • Most important settings
      • Other settings
    • Customizing the login
      • Customization via the HelmholtzAuthentificationView
        • Example
  • Configuration via Signals
    • Examples
  • User creation strategies
    • Core concept
    • Implemented strategies
  • Common problems
    • Mapping to existing accounts
    • Mapping of multiple accounts
    • Too many VOs
  • API Reference
    • 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
    • Signals
    • aai_user_created
    • aai_user_logged_in
    • aai_user_updated
    • aai_vo_created
    • aai_vo_entered
    • aai_vo_left
    • login_denied
    • URL config
    • app_name
    • urlpatterns
    • 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()
    • django_helmholtz_aai.views package
      • Views
      • HelmholtzAuthentificationView
        • HelmholtzAuthentificationView.PermissionDeniedReasons
        • 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
    • Management commands
      • Submodules
        • Remove empty virtual organizations
        • Command
  • Contribution and development hints
    • Contributing in the development
    • Helpers
      • Shortcuts with make
      • Annotating licenses
    • Fixing the docs
    • Contributing to the code
    • Updating the skeleton for this package
django-helmholtz-aai
  • API Reference
  • View page source

API Reference

  • 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
  • Signals
  • aai_user_created
  • aai_user_logged_in
  • aai_user_updated
  • aai_vo_created
  • aai_vo_entered
  • aai_vo_left
  • login_denied
  • URL config
  • app_name
  • urlpatterns
  • Models
  • HelmholtzUser
  • HelmholtzUserManager
  • HelmholtzVirtualOrganization
  • HelmholtzVirtualOrganizationManager
  • HelmholtzVirtualOrganizationQuerySet
  • django_helmholtz_aai.views package
  • Management commands
Previous Next

© Copyright 2022-2023 Helmholtz-Zentrum hereon GmbH. Revision a1a4ccb9.

Built with Sphinx using a theme provided by Read the Docs.
Creative Commons License This documentation is licensed under CC-BY-4.0