16.2.1. library functions

Based on the database models, which are tested in tests/test_db_model.py, there are different modules.

resolver.py contains functions to simply deal with resolver definitions. On this level users and realms are not know, yet.

realm.py contains functions to deal with realm. Realms are a list of several resolvers. So prior to bother the realm.py, the resolver.py should be understood and working. On this level, users are not known, yet.

user.py contains functions to deal with users. A user object is an entity in a realm. And of course the user object itself can be found in a resolver. But you need to have working resolver.py and realm.py to be able to work with user.py

privacyidea.lib.lazy_gettext(*args, **kwargs) → LazyString

For further details see the following modules:

• 16.2.1.1. Users
  • User
    • User.attributes
    • User.check_password()
    • User.delete()
    • User.delete_attribute()
    • User.exist()
    • User.get_ordered_resolvers()
    • User.get_search_fields()
    • User.get_user_identifiers()
    • User.get_user_phone()
    • User.get_user_realms()
    • User.info
    • User.is_empty()
    • User.login
    • User.realm
    • User.resolver
    • User.set_attribute()
    • User.update_user_info()
  • create_user()
  • get_attributes()
  • get_user_from_param()
  • get_user_list()
  • get_username()
  • is_attribute_at_all()
  • log_used_user()
  • split_user()
• 16.2.1.2. Token Class
  • 16.2.1.2.1. 4 Eyes Token
    • FourEyesTokenClass
      • FourEyesTokenClass.authenticate()
      • FourEyesTokenClass.check_challenge_response()
      • FourEyesTokenClass.convert_realms()
      • FourEyesTokenClass.create_challenge()
      • FourEyesTokenClass.get_class_info()
      • FourEyesTokenClass.get_class_prefix()
      • FourEyesTokenClass.get_class_type()
      • FourEyesTokenClass.has_further_challenge()
      • FourEyesTokenClass.is_challenge_request()
      • FourEyesTokenClass.realms_dict_to_string()
      • FourEyesTokenClass.update()
  • 16.2.1.2.2. Certificate Token
    • CertificateTokenClass
      • CertificateTokenClass.get_as_dict()
      • CertificateTokenClass.get_class_info()
      • CertificateTokenClass.get_class_prefix()
      • CertificateTokenClass.get_class_type()
      • CertificateTokenClass.get_default_settings()
      • CertificateTokenClass.get_init_detail()
      • CertificateTokenClass.hKeyRequired
      • CertificateTokenClass.revoke()
      • CertificateTokenClass.set_pin()
      • CertificateTokenClass.update()
      • CertificateTokenClass.using_pin
  • 16.2.1.2.3. Daplug Token
    • DaplugTokenClass
      • DaplugTokenClass.check_otp()
      • DaplugTokenClass.check_otp_exist()
      • DaplugTokenClass.get_class_info()
      • DaplugTokenClass.get_class_prefix()
      • DaplugTokenClass.get_class_type()
      • DaplugTokenClass.get_multi_otp()
      • DaplugTokenClass.get_otp()
      • DaplugTokenClass.is_multichallenge_enrollable()
      • DaplugTokenClass.resync()
      • DaplugTokenClass.split_pin_pass()
  • 16.2.1.2.4. Email Token
    • EmailTokenClass
      • EmailTokenClass.EMAIL_ADDRESS_KEY
      • EmailTokenClass.can_verify_enrollment
      • EmailTokenClass.check_otp()
      • EmailTokenClass.create_challenge()
      • EmailTokenClass.enroll_via_validate()
      • EmailTokenClass.enroll_via_validate_2nd_step()
      • EmailTokenClass.get_class_info()
      • EmailTokenClass.get_class_prefix()
      • EmailTokenClass.get_class_type()
      • EmailTokenClass.is_challenge_request()
      • EmailTokenClass.mode
      • EmailTokenClass.prepare_verify_enrollment()
      • EmailTokenClass.test_config()
      • EmailTokenClass.update()
  • 16.2.1.2.5. HOTP Token
    • HotpTokenClass
      • HotpTokenClass.can_verify_enrollment
      • HotpTokenClass.check_otp()
      • HotpTokenClass.check_otp_exist()
      • HotpTokenClass.desc_hash_func
      • HotpTokenClass.desc_key_gen
      • HotpTokenClass.desc_otp_len
      • HotpTokenClass.desc_two_step_admin
      • HotpTokenClass.desc_two_step_user
      • HotpTokenClass.enroll_via_validate()
      • HotpTokenClass.generate_symmetric_key()
      • HotpTokenClass.get_class_info()
      • HotpTokenClass.get_class_prefix()
      • HotpTokenClass.get_class_type()
      • HotpTokenClass.get_default_settings()
      • HotpTokenClass.get_enroll_url()
      • HotpTokenClass.get_import_csv()
      • HotpTokenClass.get_init_detail()
      • HotpTokenClass.get_multi_otp()
      • HotpTokenClass.get_otp()
      • HotpTokenClass.get_setting_type()
      • HotpTokenClass.get_sync_timeout()
      • HotpTokenClass.has_further_challenge()
      • HotpTokenClass.hashlib
      • HotpTokenClass.is_multichallenge_enrollable()
      • HotpTokenClass.is_previous_otp()
      • HotpTokenClass.prepare_verify_enrollment()
      • HotpTokenClass.previous_otp_offset
      • HotpTokenClass.resync()
      • HotpTokenClass.update()
      • HotpTokenClass.verify_enrollment()
  • 16.2.1.2.6. mOTP Token
    • MotpTokenClass
      • MotpTokenClass.check_otp()
      • MotpTokenClass.get_class_info()
      • MotpTokenClass.get_class_prefix()
      • MotpTokenClass.get_class_type()
      • MotpTokenClass.get_init_detail()
      • MotpTokenClass.update()
  • 16.2.1.2.7. OCRA Token
    • 16.2.1.2.7.1. Implementation
      • OcraTokenClass
        • OcraTokenClass.check_otp()
        • OcraTokenClass.create_challenge()
        • OcraTokenClass.get_class_info()
        • OcraTokenClass.get_class_prefix()
        • OcraTokenClass.get_class_type()
        • OcraTokenClass.get_import_csv()
        • OcraTokenClass.is_challenge_request()
        • OcraTokenClass.update()
        • OcraTokenClass.verify_response()
  • 16.2.1.2.8. Paper Token
    • PaperTokenClass
      • PaperTokenClass.get_class_info()
      • PaperTokenClass.get_class_prefix()
      • PaperTokenClass.get_class_type()
      • PaperTokenClass.is_multichallenge_enrollable()
      • PaperTokenClass.update()
  • 16.2.1.2.9. Passkey Token
    • 16.2.1.2.9.1. Implementation
      • PasskeyTokenClass
        • PasskeyTokenClass.authenticate()
        • PasskeyTokenClass.check_otp()
        • PasskeyTokenClass.client_mode
        • PasskeyTokenClass.create_challenge()
        • PasskeyTokenClass.get_class_info()
        • PasskeyTokenClass.get_class_prefix()
        • PasskeyTokenClass.get_class_type()
        • PasskeyTokenClass.get_default_challenge_text_auth()
        • PasskeyTokenClass.get_default_challenge_text_register()
        • PasskeyTokenClass.get_init_detail()
        • PasskeyTokenClass.inc_failcount()
        • PasskeyTokenClass.is_challenge_request()
        • PasskeyTokenClass.is_multichallenge_enrollable()
        • PasskeyTokenClass.mode
        • PasskeyTokenClass.update()
        • PasskeyTokenClass.use_for_authentication()
  • 16.2.1.2.10. PasswordToken
    • PasswordTokenClass
      • PasswordTokenClass.SecretPassword
        • PasswordTokenClass.SecretPassword.check_password()
        • PasswordTokenClass.SecretPassword.get_password()
      • PasswordTokenClass.check_otp()
      • PasswordTokenClass.default_contents
      • PasswordTokenClass.default_length
      • PasswordTokenClass.get_class_info()
      • PasswordTokenClass.get_class_prefix()
      • PasswordTokenClass.get_class_type()
      • PasswordTokenClass.get_init_detail()
      • PasswordTokenClass.password_detail_key
      • PasswordTokenClass.update()
  • 16.2.1.2.11. Push Token
    • PushTokenClass
      • PushTokenClass.api_endpoint()
      • PushTokenClass.authenticate()
      • PushTokenClass.check_challenge_response()
      • PushTokenClass.client_mode
      • PushTokenClass.create_challenge()
      • PushTokenClass.enroll_via_validate()
      • PushTokenClass.get_class_info()
      • PushTokenClass.get_class_prefix()
      • PushTokenClass.get_class_type()
      • PushTokenClass.get_enroll_url()
      • PushTokenClass.get_init_detail()
      • PushTokenClass.is_challenge_request()
      • PushTokenClass.is_multichallenge_enrollable()
      • PushTokenClass.mode
      • PushTokenClass.update()
      • PushTokenClass.use_for_authentication()
  • 16.2.1.2.12. Questionnaire Token
    • QuestionnaireTokenClass
      • QuestionnaireTokenClass.check_answer()
      • QuestionnaireTokenClass.check_challenge_response()
      • QuestionnaireTokenClass.create_challenge()
      • QuestionnaireTokenClass.get_class_info()
      • QuestionnaireTokenClass.get_class_prefix()
      • QuestionnaireTokenClass.get_class_type()
      • QuestionnaireTokenClass.get_setting_type()
      • QuestionnaireTokenClass.has_further_challenge()
      • QuestionnaireTokenClass.is_challenge_request()
      • QuestionnaireTokenClass.update()
  • 16.2.1.2.13. RADIUS Token
    • RadiusTokenClass
      • RadiusTokenClass.authenticate()
      • RadiusTokenClass.check_challenge_response()
      • RadiusTokenClass.check_otp()
      • RadiusTokenClass.check_pin_local
      • RadiusTokenClass.create_challenge()
      • RadiusTokenClass.get_class_info()
      • RadiusTokenClass.get_class_prefix()
      • RadiusTokenClass.get_class_type()
      • RadiusTokenClass.is_challenge_request()
      • RadiusTokenClass.is_challenge_response()
      • RadiusTokenClass.mode
      • RadiusTokenClass.split_pin_pass()
      • RadiusTokenClass.update()
  • 16.2.1.2.14. Registration Code Token
    • RegistrationTokenClass
      • RegistrationTokenClass.get_class_info()
      • RegistrationTokenClass.get_class_prefix()
      • RegistrationTokenClass.get_class_type()
      • RegistrationTokenClass.password_detail_key
      • RegistrationTokenClass.post_success()
      • RegistrationTokenClass.update()
  • 16.2.1.2.15. Remote Token
    • RemoteTokenClass
      • RemoteTokenClass.authenticate()
      • RemoteTokenClass.check_otp()
      • RemoteTokenClass.check_pin_local
      • RemoteTokenClass.get_class_info()
      • RemoteTokenClass.get_class_prefix()
      • RemoteTokenClass.get_class_type()
      • RemoteTokenClass.is_challenge_request()
      • RemoteTokenClass.mode
      • RemoteTokenClass.update()
  • 16.2.1.2.16. SMS Token
    • SmsTokenClass
      • SmsTokenClass.check_otp()
      • SmsTokenClass.create_challenge()
      • SmsTokenClass.enroll_via_validate()
      • SmsTokenClass.enroll_via_validate_2nd_step()
      • SmsTokenClass.get_class_info()
      • SmsTokenClass.get_class_prefix()
      • SmsTokenClass.get_class_type()
      • SmsTokenClass.is_challenge_request()
      • SmsTokenClass.mode
      • SmsTokenClass.prepare_verify_enrollment()
      • SmsTokenClass.update()
  • 16.2.1.2.17. SPass Token
    • SpassTokenClass
      • SpassTokenClass.authenticate()
      • SpassTokenClass.check_otp()
      • SpassTokenClass.get_class_info()
      • SpassTokenClass.get_class_prefix()
      • SpassTokenClass.get_class_type()
      • SpassTokenClass.is_challenge_request()
      • SpassTokenClass.is_challenge_response()
      • SpassTokenClass.mode
      • SpassTokenClass.update()
  • 16.2.1.2.18. SSHKey Token
    • SSHkeyTokenClass
      • SSHkeyTokenClass.get_class_info()
      • SSHkeyTokenClass.get_class_prefix()
      • SSHkeyTokenClass.get_class_type()
      • SSHkeyTokenClass.get_sshkey()
      • SSHkeyTokenClass.mode
      • SSHkeyTokenClass.update()
      • SSHkeyTokenClass.using_pin
  • 16.2.1.2.19. TiQR Token
    • 16.2.1.2.19.1. Enrollment
    • 16.2.1.2.19.2. Authentication
    • 16.2.1.2.19.3. Implementation
      • TiqrTokenClass
        • TiqrTokenClass.api_endpoint()
        • TiqrTokenClass.check_challenge_response()
        • TiqrTokenClass.client_mode
        • TiqrTokenClass.create_challenge()
        • TiqrTokenClass.get_class_info()
        • TiqrTokenClass.get_class_prefix()
        • TiqrTokenClass.get_class_type()
        • TiqrTokenClass.get_init_detail()
        • TiqrTokenClass.mode
        • TiqrTokenClass.update()
  • 16.2.1.2.20. TOTP Token
    • TotpTokenClass
      • TotpTokenClass.check_otp()
      • TotpTokenClass.check_otp_exist()
      • TotpTokenClass.desc_timestep
      • TotpTokenClass.get_class_info()
      • TotpTokenClass.get_class_prefix()
      • TotpTokenClass.get_class_type()
      • TotpTokenClass.get_import_csv()
      • TotpTokenClass.get_multi_otp()
      • TotpTokenClass.get_otp()
      • TotpTokenClass.get_setting_type()
      • TotpTokenClass.hashlib
      • TotpTokenClass.previous_otp_offset
      • TotpTokenClass.resync()
      • TotpTokenClass.timeshift
      • TotpTokenClass.timestep
      • TotpTokenClass.timewindow
      • TotpTokenClass.update()
  • 16.2.1.2.21. U2F Token
    • 16.2.1.2.21.1. Enrollment
      • 16.2.1.2.21.1.1. 1. Step
      • 16.2.1.2.21.1.2. 2. Step
    • 16.2.1.2.21.2. Authentication
      • 16.2.1.2.21.2.1. Get the challenge
      • 16.2.1.2.21.2.2. Send the Response
    • 16.2.1.2.21.3. Implementation
      • U2fTokenClass
        • U2fTokenClass.api_endpoint()
        • U2fTokenClass.check_otp()
        • U2fTokenClass.client_mode
        • U2fTokenClass.create_challenge()
        • U2fTokenClass.get_class_info()
        • U2fTokenClass.get_class_prefix()
        • U2fTokenClass.get_class_type()
        • U2fTokenClass.get_init_detail()
        • U2fTokenClass.is_challenge_request()
        • U2fTokenClass.update()
  • 16.2.1.2.22. Vasco Token
  • 16.2.1.2.23. WebAuthn Token
    • 16.2.1.2.23.1. Enrollment
    • 16.2.1.2.23.2. Authentication
      • 16.2.1.2.23.2.1. Get the challenge (using /validate/check)
      • 16.2.1.2.23.2.2. Get the challenge (using /validate/triggerchallenge)
      • 16.2.1.2.23.2.3. Send the Response
    • 16.2.1.2.23.3. Implementation
      • WebAuthnTokenClass
        • WebAuthnTokenClass.check_otp()
        • WebAuthnTokenClass.client_mode
        • WebAuthnTokenClass.create_challenge()
        • WebAuthnTokenClass.decrypt_otpkey()
        • WebAuthnTokenClass.get_class_info()
        • WebAuthnTokenClass.get_class_prefix()
        • WebAuthnTokenClass.get_class_type()
        • WebAuthnTokenClass.get_default_challenge_text_auth()
        • WebAuthnTokenClass.get_default_challenge_text_register()
        • WebAuthnTokenClass.get_init_detail()
        • WebAuthnTokenClass.get_setting_type()
        • WebAuthnTokenClass.is_challenge_request()
        • WebAuthnTokenClass.update()
  • 16.2.1.2.24. Yubico Token
    • YubicoTokenClass
      • YubicoTokenClass.check_otp()
      • YubicoTokenClass.get_class_info()
      • YubicoTokenClass.get_class_prefix()
      • YubicoTokenClass.get_class_type()
      • YubicoTokenClass.update()
  • 16.2.1.2.25. Yubikey Token
    • YubikeyTokenClass
      • YubikeyTokenClass.api_endpoint()
      • YubikeyTokenClass.check_otp()
      • YubikeyTokenClass.check_otp_exist()
      • YubikeyTokenClass.check_yubikey_pass()
      • YubikeyTokenClass.get_class_info()
      • YubikeyTokenClass.get_class_prefix()
      • YubikeyTokenClass.get_class_type()
      • YubikeyTokenClass.is_challenge_request()
      • YubikeyTokenClass.update()
  • TokenClass
    • TokenClass.add_init_details()
    • TokenClass.add_tokengroup()
    • TokenClass.add_tokeninfo()
    • TokenClass.add_tokeninfo_dict()
    • TokenClass.add_user()
    • TokenClass.api_endpoint()
    • TokenClass.authenticate()
    • TokenClass.can_verify_enrollment
    • TokenClass.challenge_janitor()
    • TokenClass.check_all()
    • TokenClass.check_auth_counter()
    • TokenClass.check_challenge_response()
    • TokenClass.check_failcount()
    • TokenClass.check_last_auth_newer()
    • TokenClass.check_otp()
    • TokenClass.check_otp_exist()
    • TokenClass.check_pin()
    • TokenClass.check_reset_failcount()
    • TokenClass.check_validity_period()
    • TokenClass.client_mode
    • TokenClass.create_challenge()
    • TokenClass.decode_otpkey()
    • TokenClass.del_tokengroup()
    • TokenClass.del_tokeninfo()
    • TokenClass.delete_token()
    • TokenClass.enable()
    • TokenClass.enroll_via_validate()
    • TokenClass.enroll_via_validate_2nd_step()
    • TokenClass.generate_symmetric_key()
    • TokenClass.get_as_dict()
    • TokenClass.get_class_info()
    • TokenClass.get_class_prefix()
    • TokenClass.get_class_type()
    • TokenClass.get_count_auth()
    • TokenClass.get_count_auth_max()
    • TokenClass.get_count_auth_success()
    • TokenClass.get_count_auth_success_max()
    • TokenClass.get_count_window()
    • TokenClass.get_default_settings()
    • TokenClass.get_enroll_url()
    • TokenClass.get_failcount()
    • TokenClass.get_hashlib()
    • TokenClass.get_import_csv()
    • TokenClass.get_init_detail()
    • TokenClass.get_init_details()
    • TokenClass.get_max_failcount()
    • TokenClass.get_multi_otp()
    • TokenClass.get_otp()
    • TokenClass.get_otp_count()
    • TokenClass.get_otp_count_window()
    • TokenClass.get_otplen()
    • TokenClass.get_pin_hash_seed()
    • TokenClass.get_realms()
    • TokenClass.get_serial()
    • TokenClass.get_setting_type()
    • TokenClass.get_sync_window()
    • TokenClass.get_tokeninfo()
    • TokenClass.get_tokentype()
    • TokenClass.get_type()
    • TokenClass.get_user_displayname()
    • TokenClass.get_user_id()
    • TokenClass.get_validity_period_end()
    • TokenClass.get_validity_period_start()
    • TokenClass.hKeyRequired
    • TokenClass.has_db_challenge_response()
    • TokenClass.has_further_challenge()
    • TokenClass.inc_count_auth()
    • TokenClass.inc_count_auth_success()
    • TokenClass.inc_failcount()
    • TokenClass.inc_otp_counter()
    • TokenClass.is_active()
    • TokenClass.is_challenge_request()
    • TokenClass.is_challenge_response()
    • TokenClass.is_fit_for_challenge()
    • TokenClass.is_locked()
    • TokenClass.is_multichallenge_enrollable()
    • TokenClass.is_orphaned()
    • TokenClass.is_outofband()
    • TokenClass.is_pin_change()
    • TokenClass.is_previous_otp()
    • TokenClass.is_revoked()
    • TokenClass.mode
    • TokenClass.owners
    • TokenClass.post_success()
    • TokenClass.prepare_verify_enrollment()
    • TokenClass.reset()
    • TokenClass.resync()
    • TokenClass.revoke()
    • TokenClass.rollout_state
    • TokenClass.save()
    • TokenClass.set_count_auth()
    • TokenClass.set_count_auth_max()
    • TokenClass.set_count_auth_success()
    • TokenClass.set_count_auth_success_max()
    • TokenClass.set_count_window()
    • TokenClass.set_defaults()
    • TokenClass.set_description()
    • TokenClass.set_failcount()
    • TokenClass.set_hashlib()
    • TokenClass.set_init_details()
    • TokenClass.set_maxfail()
    • TokenClass.set_next_pin_change()
    • TokenClass.set_otp_count()
    • TokenClass.set_otpkey()
    • TokenClass.set_otplen()
    • TokenClass.set_pin()
    • TokenClass.set_pin_hash_seed()
    • TokenClass.set_realms()
    • TokenClass.set_so_pin()
    • TokenClass.set_sync_window()
    • TokenClass.set_tokengroups()
    • TokenClass.set_tokeninfo()
    • TokenClass.set_type()
    • TokenClass.set_user_pin()
    • TokenClass.set_validity_period_end()
    • TokenClass.set_validity_period_start()
    • TokenClass.split_pin_pass()
    • TokenClass.status_validation_fail()
    • TokenClass.status_validation_success()
    • TokenClass.test_config()
    • TokenClass.update()
    • TokenClass.use_for_authentication()
    • TokenClass.user
    • TokenClass.using_pin
    • TokenClass.verify_enrollment()
• 16.2.1.3. Token Functions
  • add_tokeninfo()
  • assign_token()
  • assign_tokengroup()
  • challenge_text_replace()
  • check_otp()
  • check_realm_pass()
  • check_serial()
  • check_serial_pass()
  • check_token_list()
  • check_user_pass()
  • clob_to_varchar
    • clob_to_varchar.inherit_cache
    • clob_to_varchar.name
  • convert_token_objects_to_dicts()
  • copy_token_pin()
  • copy_token_realms()
  • copy_token_user()
  • create_challenges_from_tokens()
  • create_tokenclass_object()
  • delete_tokeninfo()
  • enable_token()
  • fn_clob_to_varchar_default()
  • fn_clob_to_varchar_oracle()
  • gen_serial()
  • get_dynamic_policy_definitions()
  • get_multi_otp()
  • get_num_tokens_in_realm()
  • get_one_token()
  • get_otp()
  • get_realms_of_token()
  • get_serial_by_otp()
  • get_serial_by_otp_list()
  • get_token_by_otp()
  • get_token_owner()
  • get_token_type()
  • get_tokenclass_info()
  • get_tokeninfo()
  • get_tokens()
  • get_tokens_from_serial_or_user()
  • get_tokens_in_resolver()
  • get_tokens_paginate()
  • get_tokens_paginated_generator()
  • import_token()
  • init_token()
  • is_token_active()
  • is_token_owner()
  • list_tokengroups()
  • lost_token()
  • regenerate_enroll_url()
  • remove_token()
  • reset_token()
  • resync_token()
  • revoke_token()
  • set_count_auth()
  • set_count_window()
  • set_defaults()
  • set_description()
  • set_failcounter()
  • set_hashlib()
  • set_max_failcount()
  • set_otplen()
  • set_pin()
  • set_pin_so()
  • set_pin_user()
  • set_realms()
  • set_sync_window()
  • set_tokengroups()
  • set_validity_period_end()
  • set_validity_period_start()
  • token_dump()
  • token_exist()
  • token_load()
  • unassign_token()
  • unassign_tokengroup()
  • weigh_token_type()
• 16.2.1.4. Container Class
  • 16.2.1.4.1. Smartphone Container
    • SmartphoneContainer
      • SmartphoneContainer.check_challenge_response()
      • SmartphoneContainer.create_challenge()
      • SmartphoneContainer.encrypt_dict()
      • SmartphoneContainer.finalize_registration()
      • SmartphoneContainer.get_class_description()
      • SmartphoneContainer.get_class_prefix()
      • SmartphoneContainer.get_class_type()
      • SmartphoneContainer.get_supported_token_types()
      • SmartphoneContainer.get_tokens_for_synchronization()
      • SmartphoneContainer.init_registration()
      • SmartphoneContainer.options
      • SmartphoneContainer.terminate_registration()
  • 16.2.1.4.2. Yubikey Container
    • YubikeyContainer
      • YubikeyContainer.get_class_description()
      • YubikeyContainer.get_class_prefix()
      • YubikeyContainer.get_class_type()
      • YubikeyContainer.get_supported_token_types()
      • YubikeyContainer.options
  • 16.2.1.4.3. Generic
    • TokenContainerClass
      • TokenContainerClass.add_options()
      • TokenContainerClass.add_states()
      • TokenContainerClass.add_token()
      • TokenContainerClass.add_user()
      • TokenContainerClass.check_challenge_response()
      • TokenContainerClass.create_challenge()
      • TokenContainerClass.db_id
      • TokenContainerClass.delete()
      • TokenContainerClass.delete_container_info()
      • TokenContainerClass.description
      • TokenContainerClass.encrypt_dict()
      • TokenContainerClass.finalize_registration()
      • TokenContainerClass.get_as_dict()
      • TokenContainerClass.get_class_description()
      • TokenContainerClass.get_class_options()
      • TokenContainerClass.get_class_prefix()
      • TokenContainerClass.get_class_type()
      • TokenContainerClass.get_container_info()
      • TokenContainerClass.get_container_info_dict()
      • TokenContainerClass.get_internal_info_keys()
      • TokenContainerClass.get_state_types()
      • TokenContainerClass.get_states()
      • TokenContainerClass.get_supported_token_types()
      • TokenContainerClass.get_tokens()
      • TokenContainerClass.get_tokens_for_synchronization()
      • TokenContainerClass.get_users()
      • TokenContainerClass.init_registration()
      • TokenContainerClass.last_authentication
      • TokenContainerClass.last_synchronization
      • TokenContainerClass.options
      • TokenContainerClass.realms
      • TokenContainerClass.remove_token()
      • TokenContainerClass.remove_user()
      • TokenContainerClass.reset_last_authentication()
      • TokenContainerClass.reset_last_synchronization()
      • TokenContainerClass.serial
      • TokenContainerClass.set_container_info()
      • TokenContainerClass.set_default_option()
      • TokenContainerClass.set_realms()
      • TokenContainerClass.set_states()
      • TokenContainerClass.synchronize_container_details()
      • TokenContainerClass.template
      • TokenContainerClass.terminate_registration()
      • TokenContainerClass.type
      • TokenContainerClass.update_container_info()
      • TokenContainerClass.update_last_authentication()
      • TokenContainerClass.update_last_synchronization()
      • TokenContainerClass.validate_challenge()
• 16.2.1.5. Container Functions
  • add_container_info()
  • add_container_realms()
  • add_container_states()
  • add_multiple_tokens_to_container()
  • add_not_authorized_tokens_result()
  • add_token_to_container()
  • assign_user()
  • compare_template_dicts()
  • compare_template_with_container()
  • create_container_dict()
  • create_container_from_db_object()
  • create_container_template()
  • create_container_template_from_db_object()
  • create_container_tokens_from_template()
  • create_endpoint_url()
  • create_pagination()
  • delete_container_by_id()
  • delete_container_by_serial()
  • delete_container_info()
  • finalize_container_rollover()
  • finalize_registration()
  • find_container_by_id()
  • find_container_by_serial()
  • find_container_for_token()
  • get_all_containers()
  • get_all_templates_with_type()
  • get_container_classes()
  • get_container_classes_descriptions()
  • get_container_info_dict()
  • get_container_policy_info()
  • get_container_realms()
  • get_container_template_classes()
  • get_container_token_types()
  • get_offline_token_serials()
  • get_template_obj()
  • get_templates_by_query()
  • init_container()
  • init_container_rollover()
  • remove_multiple_tokens_from_container()
  • remove_token_from_container()
  • set_container_description()
  • set_container_info()
  • set_container_realms()
  • set_container_states()
  • set_default_template()
  • set_options()
  • unassign_user()
  • unregister()
• 16.2.1.6. Application Class
  • MachineApplicationBase
• 16.2.1.7. Policy Module
  • 16.2.1.7.1. realm and resolver
  • 16.2.1.7.2. user
  • 16.2.1.7.3. client
  • 16.2.1.7.4. time
  • ACTION
    • ACTION.ADDRESOLVERINRESPONSE
    • ACTION.ADDUSER
    • ACTION.ADDUSERINRESPONSE
    • ACTION.ADMIN_DASHBOARD
    • ACTION.APIKEY
    • ACTION.APPIMAGEURL
    • ACTION.APPLICATION_TOKENTYPE
    • ACTION.ASSIGN
    • ACTION.AUDIT
    • ACTION.AUDITPAGESIZE
    • ACTION.AUDIT_AGE
    • ACTION.AUDIT_DOWNLOAD
    • ACTION.AUTHITEMS
    • ACTION.AUTHMAXFAIL
    • ACTION.AUTHMAXSUCCESS
    • ACTION.AUTHORIZED
    • ACTION.AUTH_CACHE
    • ACTION.AUTOASSIGN
    • ACTION.CACONNECTORDELETE
    • ACTION.CACONNECTORREAD
    • ACTION.CACONNECTORWRITE
    • ACTION.CHALLENGERESPONSE
    • ACTION.CHALLENGETEXT
    • ACTION.CHALLENGETEXT_FOOTER
    • ACTION.CHALLENGETEXT_HEADER
    • ACTION.CHANGE_PIN_EVERY
    • ACTION.CHANGE_PIN_FIRST_USE
    • ACTION.CHANGE_PIN_VIA_VALIDATE
    • ACTION.CLIENTTYPE
    • ACTION.CONFIGDOCUMENTATION
    • ACTION.CONTAINER_ADD_TOKEN
    • ACTION.CONTAINER_ASSIGN_USER
    • ACTION.CONTAINER_CHALLENGE_TTL
    • ACTION.CONTAINER_CLIENT_ROLLOVER
    • ACTION.CONTAINER_CREATE
    • ACTION.CONTAINER_DELETE
    • ACTION.CONTAINER_DESCRIPTION
    • ACTION.CONTAINER_INFO
    • ACTION.CONTAINER_LIST
    • ACTION.CONTAINER_REALMS
    • ACTION.CONTAINER_REGISTER
    • ACTION.CONTAINER_REGISTRATION_TTL
    • ACTION.CONTAINER_REMOVE_TOKEN
    • ACTION.CONTAINER_ROLLOVER
    • ACTION.CONTAINER_SSL_VERIFY
    • ACTION.CONTAINER_STATE
    • ACTION.CONTAINER_TEMPLATE_CREATE
    • ACTION.CONTAINER_TEMPLATE_DELETE
    • ACTION.CONTAINER_TEMPLATE_LIST
    • ACTION.CONTAINER_UNASSIGN_USER
    • ACTION.CONTAINER_UNREGISTER
    • ACTION.CONTAINER_WIZARD_REGISTRATION
    • ACTION.CONTAINER_WIZARD_TEMPLATE
    • ACTION.CONTAINER_WIZARD_TYPE
    • ACTION.COPYTOKENPIN
    • ACTION.COPYTOKENUSER
    • ACTION.CUSTOM_BASELINE
    • ACTION.CUSTOM_MENU
    • ACTION.DEFAULT_CONTAINER_TYPE
    • ACTION.DEFAULT_TOKENTYPE
    • ACTION.DELETE
    • ACTION.DELETEUSER
    • ACTION.DELETE_USER_ATTRIBUTES
    • ACTION.DELETION_CONFIRMATION
    • ACTION.DIALOG_NO_TOKEN
    • ACTION.DISABLE
    • ACTION.DISABLE_CLIENT_CONTAINER_UNREGISTER
    • ACTION.DISABLE_CLIENT_TOKEN_DELETION
    • ACTION.EMAILCONFIG
    • ACTION.EMAILVALIDATION
    • ACTION.ENABLE
    • ACTION.ENCRYPTPIN
    • ACTION.ENROLLPIN
    • ACTION.ENROLL_VIA_MULTICHALLENGE
    • ACTION.ENROLL_VIA_MULTICHALLENGE_TEXT
    • ACTION.EVENTHANDLINGREAD
    • ACTION.EVENTHANDLINGWRITE
    • ACTION.FORCE_APP_PIN
    • ACTION.FORCE_CHALLENGE_RESPONSE
    • ACTION.GDPR_LINK
    • ACTION.GETCHALLENGES
    • ACTION.GETRANDOM
    • ACTION.GETSERIAL
    • ACTION.HIDE_AUDIT_COLUMNS
    • ACTION.HIDE_BUTTONS
    • ACTION.HIDE_TOKENINFO
    • ACTION.HIDE_WELCOME
    • ACTION.IMPORT
    • ACTION.INCREASE_FAILCOUNTER_ON_CHALLENGE
    • ACTION.INITIALLY_ADD_TOKENS_TO_CONTAINER
    • ACTION.JWTVALIDITY
    • ACTION.LASTAUTH
    • ACTION.LOGINMODE
    • ACTION.LOGIN_TEXT
    • ACTION.LOGOUTTIME
    • ACTION.LOGOUT_REDIRECT
    • ACTION.LOSTTOKEN
    • ACTION.LOSTTOKENPWCONTENTS
    • ACTION.LOSTTOKENPWLEN
    • ACTION.LOSTTOKENVALID
    • ACTION.MACHINELIST
    • ACTION.MACHINERESOLVERDELETE
    • ACTION.MACHINERESOLVERREAD
    • ACTION.MACHINERESOLVERWRITE
    • ACTION.MACHINETOKENS
    • ACTION.MANAGESUBSCRIPTION
    • ACTION.MANGLE
    • ACTION.MAXACTIVETOKENUSER
    • ACTION.MAXTOKENREALM
    • ACTION.MAXTOKENUSER
    • ACTION.NODETAILFAIL
    • ACTION.NODETAILSUCCESS
    • ACTION.OTPPIN
    • ACTION.OTPPINCONTENTS
    • ACTION.OTPPINMAXLEN
    • ACTION.OTPPINMINLEN
    • ACTION.OTPPINRANDOM
    • ACTION.OTPPINSETRANDOM
    • ACTION.PASSNOTOKEN
    • ACTION.PASSNOUSER
    • ACTION.PASSTHRU
    • ACTION.PASSTHRU_ASSIGN
    • ACTION.PASSWORDRESET
    • ACTION.PASSWORD_CONTENTS
    • ACTION.PASSWORD_LENGTH
    • ACTION.PERIODICTASKREAD
    • ACTION.PERIODICTASKWRITE
    • ACTION.PINHANDLING
    • ACTION.PI_SERVER_URL
    • ACTION.POLICYDELETE
    • ACTION.POLICYREAD
    • ACTION.POLICYTEMPLATEURL
    • ACTION.POLICYWRITE
    • ACTION.PREFERREDCLIENTMODE
    • ACTION.PRIVACYIDEASERVERREAD
    • ACTION.PRIVACYIDEASERVERWRITE
    • ACTION.RADIUSSERVERREAD
    • ACTION.RADIUSSERVERWRITE
    • ACTION.REALM
    • ACTION.REALMDROPDOWN
    • ACTION.REGISTERBODY
    • ACTION.REGISTRATIONCODE_CONTENTS
    • ACTION.REGISTRATIONCODE_LENGTH
    • ACTION.REMOTE_USER
    • ACTION.REQUIREDEMAIL
    • ACTION.REQUIRE_DESCRIPTION
    • ACTION.RESET
    • ACTION.RESETALLTOKENS
    • ACTION.RESOLVER
    • ACTION.RESOLVERDELETE
    • ACTION.RESOLVERREAD
    • ACTION.RESOLVERWRITE
    • ACTION.RESYNC
    • ACTION.RESYNC_VIA_MULTICHALLENGE
    • ACTION.REVOKE
    • ACTION.RSS_AGE
    • ACTION.RSS_FEEDS
    • ACTION.SEARCH_ON_ENTER
    • ACTION.SERIAL
    • ACTION.SERVICEID_ADD
    • ACTION.SERVICEID_DELETE
    • ACTION.SERVICEID_LIST
    • ACTION.SET
    • ACTION.SETDESCRIPTION
    • ACTION.SETHSM
    • ACTION.SETPIN
    • ACTION.SETRANDOMPIN
    • ACTION.SETREALM
    • ACTION.SETTOKENINFO
    • ACTION.SET_USER_ATTRIBUTES
    • ACTION.SHOW_ANDROID_AUTHENTICATOR
    • ACTION.SHOW_CUSTOM_AUTHENTICATOR
    • ACTION.SHOW_IOS_AUTHENTICATOR
    • ACTION.SHOW_NODE
    • ACTION.SHOW_SEED
    • ACTION.SMSGATEWAYREAD
    • ACTION.SMSGATEWAYWRITE
    • ACTION.SMTPSERVERREAD
    • ACTION.SMTPSERVERWRITE
    • ACTION.STATISTICSDELETE
    • ACTION.STATISTICSREAD
    • ACTION.SYSTEMDELETE
    • ACTION.SYSTEMREAD
    • ACTION.SYSTEMWRITE
    • ACTION.TIMEOUT_ACTION
    • ACTION.TOKENGROUPS
    • ACTION.TOKENGROUP_ADD
    • ACTION.TOKENGROUP_DELETE
    • ACTION.TOKENGROUP_LIST
    • ACTION.TOKENINFO
    • ACTION.TOKENISSUER
    • ACTION.TOKENLABEL
    • ACTION.TOKENLIST
    • ACTION.TOKENPAGESIZE
    • ACTION.TOKENREALMS
    • ACTION.TOKENROLLOVER
    • ACTION.TOKENTYPE
    • ACTION.TOKENWIZARD
    • ACTION.TOKENWIZARD2ND
    • ACTION.TRIGGERCHALLENGE
    • ACTION.UNASSIGN
    • ACTION.UPDATEUSER
    • ACTION.USERDETAILS
    • ACTION.USERLIST
    • ACTION.USERPAGESIZE
    • ACTION.VERIFY_ENROLLMENT
  • ACTIONVALUE
    • ACTIONVALUE.DISABLE
    • ACTIONVALUE.NONE
    • ACTIONVALUE.TOKENPIN
    • ACTIONVALUE.USERSTORE
  • AUTHORIZED
    • AUTHORIZED.ALLOW
    • AUTHORIZED.DENY
  • AUTOASSIGNVALUE
    • AUTOASSIGNVALUE.NONE
    • AUTOASSIGNVALUE.USERSTORE
  • CONDITION_CHECK
    • CONDITION_CHECK.CHECK_AND_RAISE_EXCEPTION_ON_MISSING
    • CONDITION_CHECK.DO_NOT_CHECK_AT_ALL
    • CONDITION_CHECK.ONLY_CHECK_USERINFO
  • CONDITION_SECTION
    • CONDITION_SECTION.HTTP_ENVIRONMENT
    • CONDITION_SECTION.HTTP_REQUEST_HEADER
    • CONDITION_SECTION.TOKEN
    • CONDITION_SECTION.TOKENINFO
    • CONDITION_SECTION.USERINFO
  • GROUP
    • GROUP.CONDITIONS
    • GROUP.CONTAINER
    • GROUP.ENROLLMENT
    • GROUP.GENERAL
    • GROUP.MACHINE
    • GROUP.MODIFYING_RESPONSE
    • GROUP.PIN
    • GROUP.REGISTRATION
    • GROUP.SERVICEID
    • GROUP.SETTING_ACTIONS
    • GROUP.SMARTPHONE
    • GROUP.SYSTEM
    • GROUP.TOKEN
    • GROUP.TOKENGROUP
    • GROUP.TOOLS
    • GROUP.USER
    • GROUP.WIZARD
  • LOGINMODE
    • LOGINMODE.DISABLE
    • LOGINMODE.PRIVACYIDEA
    • LOGINMODE.USERSTORE
  • MAIN_MENU
    • MAIN_MENU.AUDIT
    • MAIN_MENU.COMPONENTS
    • MAIN_MENU.CONFIG
    • MAIN_MENU.MACHINES
    • MAIN_MENU.TOKENS
    • MAIN_MENU.USERS
  • Match
    • Match.action_only()
    • Match.action_values()
    • Match.admin()
    • Match.admin_or_user()
    • Match.allowed()
    • Match.any()
    • Match.generic()
    • Match.policies()
    • Match.realm()
    • Match.token()
    • Match.user()
  • MatchingError
  • PolicyClass
    • PolicyClass.check_for_conflicts()
    • PolicyClass.extract_action_values()
    • PolicyClass.filter_policies_by_conditions()
    • PolicyClass.get_action_values()
    • PolicyClass.list_policies()
    • PolicyClass.match_policies()
    • PolicyClass.policies
    • PolicyClass.ui_get_enroll_tokentypes()
    • PolicyClass.ui_get_main_menus()
    • PolicyClass.ui_get_rights()
  • REMOTE_USER
    • REMOTE_USER.ACTIVE
    • REMOTE_USER.DISABLE
    • REMOTE_USER.FORCE
  • SCOPE
    • SCOPE.ADMIN
    • SCOPE.AUDIT
    • SCOPE.AUTH
    • SCOPE.AUTHZ
    • SCOPE.CONTAINER
    • SCOPE.ENROLL
    • SCOPE.REGISTER
    • SCOPE.USER
    • SCOPE.WEBUI
  • TIMEOUT_ACTION
    • TIMEOUT_ACTION.LOCKSCREEN
    • TIMEOUT_ACTION.LOGOUT
  • TYPE
    • TYPE.BOOL
    • TYPE.INT
    • TYPE.STRING
  • check_pin()
  • convert_action_dict_to_python_dict()
  • delete_all_policies()
  • delete_policies()
  • delete_policy()
  • enable_policy()
  • export_policies()
  • export_policy()
  • get_action_values_from_options()
  • get_allowed_custom_attributes()
  • get_policy_condition_comparators()
  • get_policy_condition_sections()
  • get_static_policy_definitions()
  • import_policies()
  • import_policy()
  • set_policy()
• 16.2.1.8. Job Queue
  • 16.2.1.8.1. Huey Queue Class
    • HueyQueue
      • HueyQueue.enqueue()
      • HueyQueue.huey
      • HueyQueue.jobs
      • HueyQueue.register_job()
  • JOB_COLLECTOR
  • JobCollector
    • JobCollector.jobs
    • JobCollector.register_app()
    • JobCollector.register_job()
  • get_job_queue()
  • has_job_queue()
  • job()
  • register_app()
  • wrap_job()
  • 16.2.1.8.2. Base class
    • BaseQueue
      • BaseQueue.enqueue()
      • BaseQueue.register_job()
• 16.2.1.9. API Policies
  • 16.2.1.9.1. Pre Policies
    • allowed_audit_realm()
    • api_key_required()
    • auditlog_age()
    • check_admin_tokenlist()
    • check_anonymous_user()
    • check_application_tokentype()
    • check_base_action()
    • check_client_container_action()
    • check_client_container_disabled_action()
    • check_container_action()
    • check_container_register_rollover()
    • check_custom_user_attributes()
    • check_external()
    • check_max_token_realm()
    • check_max_token_user()
    • check_otp_pin()
    • check_token_action()
    • check_token_init()
    • check_token_list_action()
    • check_token_upload()
    • check_user_params()
    • container_registration_config()
    • encrypt_pin()
    • enroll_pin()
    • fido2_auth()
    • fido2_enroll()
    • get_first_policy_value()
    • hide_audit_columns()
    • hide_tokeninfo()
    • increase_failcounter_on_challenge()
    • indexedsecret_force_attribute()
    • init_ca_connector()
    • init_ca_template()
    • init_random_pin()
    • init_subject_components()
    • init_token_defaults()
    • init_token_length_contents()
    • init_tokenlabel()
    • is_remote_user_allowed()
    • jwt_validity()
    • mangle()
    • mock_fail()
    • mock_success()
    • papertoken_count()
    • prepolicy
    • pushtoken_add_config()
    • pushtoken_disable_wait()
    • pushtoken_validate()
    • realmadmin()
    • require_description()
    • required_email()
    • required_piv_attestation()
    • rss_age()
    • save_client_application_type()
    • set_random_pin()
    • set_realm()
    • smartphone_config()
    • sms_identifiers()
    • tantoken_count()
    • twostep_enrollment_activation()
    • twostep_enrollment_parameters()
    • u2ftoken_allowed()
    • u2ftoken_verify_cert()
    • verify_enrollment()
    • webauthntoken_allowed()
    • webauthntoken_authz()
    • webauthntoken_request()
  • 16.2.1.9.2. Post Policies
    • add_user_detail_to_response()
    • autoassign()
    • check_serial()
    • check_tokeninfo()
    • check_tokentype()
    • check_verify_enrollment()
    • construct_radius_response()
    • get_webui_settings()
    • is_authorized()
    • mangle_challenge_response()
    • multichallenge_enroll_via_validate()
    • no_detail_on_fail()
    • no_detail_on_success()
    • offline_info()
    • postpolicy
    • postrequest
    • preferred_client_mode()
    • save_pin_change()
    • sign_response()
• 16.2.1.10. Policy Decorators
  • auth_cache()
  • auth_lastauth()
  • auth_otppin()
  • auth_user_does_not_exist()
  • auth_user_has_no_token()
  • auth_user_passthru()
  • auth_user_timelimit()
  • challenge_response_allowed()
  • config_lost_token()
  • force_challenge_response()
  • libpolicy
  • login_mode()
  • reset_all_user_tokens()
• 16.2.1.11. Event Handler
  • 16.2.1.11.1. Event Handler Base Class
    • BaseEventHandler
      • BaseEventHandler.actions
      • BaseEventHandler.allowed_positions
      • BaseEventHandler.check_condition()
      • BaseEventHandler.conditions
      • BaseEventHandler.description
      • BaseEventHandler.do()
      • BaseEventHandler.events
      • BaseEventHandler.identifier
      • BaseEventHandler.run_details
  • 16.2.1.11.2. User Notification Event Handler
    • UserNotificationEventHandler
      • UserNotificationEventHandler.actions
      • UserNotificationEventHandler.allowed_positions
      • UserNotificationEventHandler.attach_qr()
      • UserNotificationEventHandler.description
      • UserNotificationEventHandler.do()
      • UserNotificationEventHandler.identifier
  • EventConfiguration
    • EventConfiguration.events
    • EventConfiguration.get_event()
    • EventConfiguration.get_handled_events()
  • delete_event()
  • enable_event()
  • event
  • export_event()
  • get_handler_object()
  • import_event()
  • set_event()
• 16.2.1.12. SMS Provider
  • 16.2.1.12.1. HTTP SMS Provider
    • HttpSMSProvider
      • HttpSMSProvider.parameters()
      • HttpSMSProvider.submit_message()
  • 16.2.1.12.2. Sipgate SMS Provider
    • SipgateSMSProvider
      • SipgateSMSProvider.parameters()
      • SipgateSMSProvider.submit_message()
  • 16.2.1.12.3. SMTP SMS Provider
    • SmtpSMSProvider
      • SmtpSMSProvider.parameters()
      • SmtpSMSProvider.submit_message()
  • 16.2.1.12.4. Base Class
    • ISMSProvider
      • ISMSProvider.check_configuration()
      • ISMSProvider.load_config()
      • ISMSProvider.parameters()
      • ISMSProvider.regexp_description
      • ISMSProvider.submit_message()