14. Code Documentation¶
The code roughly has three levels: API, LIB and DB.
14.1. API level¶
The API level is used to access the system.
For some calls you need to be authenticated as administrator,
for some calls you can be authenticated as normal user.
These are the token and the audit endpoint.
For calls to the validate API you do not need to be authenticated at all.
At this level Authentication is performed. In the lower levels there is no
authentication anymore.
The object g.logged_in_user is used to pass the authenticated user.
The client gets a JSON Web Token to authenticate every request.
API functions are decorated with the decorators admin_required and
user_required to define access rules.
- 14.1.1. REST API
- 14.1.1.1. Audit endpoint
- 14.1.1.2. Authentication endpoints
- 14.1.1.3. Validate endpoints
- 14.1.1.4. System endpoints
- 14.1.1.5. Tokengroup endpoints
- 14.1.1.6. Service ID endpoints
- 14.1.1.7. Resolver endpoints
- 14.1.1.8. Realm endpoints
- 14.1.1.9. Default Realm endpoints
- 14.1.1.10. Token endpoints
- 14.1.1.11. User endpoints
- 14.1.1.12. Policy endpoints
- 14.1.1.13. Event endpoints
- 14.1.1.14. Machine Resolver endpoints
- 14.1.1.15. Machine endpoints
- 14.1.1.16. CA Connector endpoints
- 14.1.1.17. Recover endpoints
- 14.1.1.18. Register endpoints
- 14.1.1.19. Monitoring endpoints
- 14.1.1.20. Periodic Task endpoints
- 14.1.1.21. Application endpoints
- 14.1.1.22. Tokentype endpoints
- 14.1.1.23. SMTP server endpoints
- 14.1.1.24. SMS Gateway endpoints
- 14.1.1.25. RADIUS server endpoints
- 14.1.1.26. Client endpoints
14.2. LIB level¶
At the LIB level all library functions are defined. There is no authentication on this level. Also there is no flask/Web/request code on this level.
Request information and the logged_in_user need to be passed to the
functions as parameters, if they are needed.
If possible, policies are checked with policy decorators.
- 14.2.1. library functions
- 14.2.1.1. Users
UserUser.attributesUser.check_password()User.delete()User.delete_attribute()User.exist()User.get_ordererd_resolvers()User.get_search_fields()User.get_user_identifiers()User.get_user_phone()User.get_user_realms()User.infoUser.is_empty()User.loginUser.realmUser.resolverUser.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()
- 14.2.1.2. Token Class
- 14.2.1.2.1. 4 Eyes Token
FourEyesTokenClassFourEyesTokenClass.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()
- 14.2.1.2.2. Certificate Token
CertificateTokenClassCertificateTokenClass.get_as_dict()CertificateTokenClass.get_class_info()CertificateTokenClass.get_class_prefix()CertificateTokenClass.get_class_type()CertificateTokenClass.get_default_settings()CertificateTokenClass.get_init_detail()CertificateTokenClass.hKeyRequiredCertificateTokenClass.revoke()CertificateTokenClass.set_pin()CertificateTokenClass.update()CertificateTokenClass.using_pin
- 14.2.1.2.3. Daplug Token
DaplugTokenClassDaplugTokenClass.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_enrollableDaplugTokenClass.resync()DaplugTokenClass.split_pin_pass()
- 14.2.1.2.4. eduPUSH Token
PushTokenClassPushTokenClass.PUSH_ACTIONPushTokenClass.PUSH_ACTION.ALLOW_POLLINGPushTokenClass.PUSH_ACTION.FIREBASE_CONFIGPushTokenClass.PUSH_ACTION.MOBILE_TEXTPushTokenClass.PUSH_ACTION.MOBILE_TITLEPushTokenClass.PUSH_ACTION.REGISTRATION_URLPushTokenClass.PUSH_ACTION.SSL_VERIFYPushTokenClass.PUSH_ACTION.TTLPushTokenClass.PUSH_ACTION.WAIT
PushTokenClass.api_endpoint()PushTokenClass.authenticate()PushTokenClass.check_challenge_response()PushTokenClass.client_modePushTokenClass.create_challenge()PushTokenClass.create_push_token_url()PushTokenClass.enroll_via_validate()PushTokenClass.get_class_description()PushTokenClass.get_class_info()PushTokenClass.get_class_prefix()PushTokenClass.get_class_title()PushTokenClass.get_class_type()PushTokenClass.get_init_detail()PushTokenClass.get_policy_group()PushTokenClass.get_push_url_prefix()PushTokenClass.get_pushtoken_add_config()PushTokenClass.is_challenge_request()PushTokenClass.is_multichallenge_enrollablePushTokenClass.modePushTokenClass.update()PushTokenClass.use_for_authentication()PushTokenClass.verify_signature()
- 14.2.1.2.5. Email Token
EmailTokenClassEmailTokenClass.EMAIL_ADDRESS_KEYEmailTokenClass.can_verify_enrollmentEmailTokenClass.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.modeEmailTokenClass.prepare_verify_enrollment()EmailTokenClass.test_config()EmailTokenClass.update()
- 14.2.1.2.6. HOTP Token
HotpTokenClassHotpTokenClass.can_verify_enrollmentHotpTokenClass.check_otp()HotpTokenClass.check_otp_exist()HotpTokenClass.desc_hash_funcHotpTokenClass.desc_key_genHotpTokenClass.desc_otp_lenHotpTokenClass.desc_two_step_adminHotpTokenClass.desc_two_step_userHotpTokenClass.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_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.hashlibHotpTokenClass.is_multichallenge_enrollableHotpTokenClass.is_previous_otp()HotpTokenClass.prepare_verify_enrollment()HotpTokenClass.previous_otp_offsetHotpTokenClass.resync()HotpTokenClass.update()HotpTokenClass.verify_enrollment()
- 14.2.1.2.7. mOTP Token
- 14.2.1.2.8. OCRA Token
- 14.2.1.2.9. Paper Token
- 14.2.1.2.10. PasswordToken
PasswordTokenClassPasswordTokenClass.SecretPasswordPasswordTokenClass.check_otp()PasswordTokenClass.default_contentsPasswordTokenClass.default_lengthPasswordTokenClass.get_class_info()PasswordTokenClass.get_class_prefix()PasswordTokenClass.get_class_type()PasswordTokenClass.get_init_detail()PasswordTokenClass.password_detail_keyPasswordTokenClass.update()
- 14.2.1.2.11. Legacy PUSH Token
LegacyPushTokenClassLegacyPushTokenClass.PUSH_ACTIONLegacyPushTokenClass.PUSH_ACTION.ALLOW_POLLINGLegacyPushTokenClass.PUSH_ACTION.FIREBASE_CONFIGLegacyPushTokenClass.PUSH_ACTION.MOBILE_TEXTLegacyPushTokenClass.PUSH_ACTION.MOBILE_TITLELegacyPushTokenClass.PUSH_ACTION.REGISTRATION_URLLegacyPushTokenClass.PUSH_ACTION.SSL_VERIFYLegacyPushTokenClass.PUSH_ACTION.TTLLegacyPushTokenClass.PUSH_ACTION.WAIT
LegacyPushTokenClass.get_class_description()LegacyPushTokenClass.get_class_prefix()LegacyPushTokenClass.get_class_title()LegacyPushTokenClass.get_class_type()LegacyPushTokenClass.get_policy_group()LegacyPushTokenClass.get_push_url_prefix()LegacyPushTokenClass.get_pushtoken_add_config()
- 14.2.1.2.12. Questionnaire Token
QuestionnaireTokenClassQuestionnaireTokenClass.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()
- 14.2.1.2.13. RADIUS Token
RadiusTokenClassRadiusTokenClass.authenticate()RadiusTokenClass.check_challenge_response()RadiusTokenClass.check_otp()RadiusTokenClass.check_pin_localRadiusTokenClass.create_challenge()RadiusTokenClass.get_class_info()RadiusTokenClass.get_class_prefix()RadiusTokenClass.get_class_type()RadiusTokenClass.is_challenge_request()RadiusTokenClass.is_challenge_response()RadiusTokenClass.modeRadiusTokenClass.split_pin_pass()RadiusTokenClass.update()
- 14.2.1.2.14. Registration Code Token
- 14.2.1.2.15. Remote Token
- 14.2.1.2.16. SMS Token
SmsTokenClassSmsTokenClass.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.modeSmsTokenClass.prepare_verify_enrollment()SmsTokenClass.update()
- 14.2.1.2.17. SPass Token
- 14.2.1.2.18. SSHKey Token
- 14.2.1.2.19. TiQR Token
- 14.2.1.2.19.1. Enrollment
- 14.2.1.2.19.2. Authentication
- 14.2.1.2.19.3. Implementation
TiqrTokenClassTiqrTokenClass.api_endpoint()TiqrTokenClass.check_challenge_response()TiqrTokenClass.client_modeTiqrTokenClass.create_challenge()TiqrTokenClass.get_class_info()TiqrTokenClass.get_class_prefix()TiqrTokenClass.get_class_type()TiqrTokenClass.get_init_detail()TiqrTokenClass.modeTiqrTokenClass.update()
- 14.2.1.2.20. TOTP Token
TotpTokenClassTotpTokenClass.check_otp()TotpTokenClass.check_otp_exist()TotpTokenClass.desc_timestepTotpTokenClass.get_class_info()TotpTokenClass.get_class_prefix()TotpTokenClass.get_class_type()TotpTokenClass.get_default_settings()TotpTokenClass.get_import_csv()TotpTokenClass.get_multi_otp()TotpTokenClass.get_otp()TotpTokenClass.get_setting_type()TotpTokenClass.hashlibTotpTokenClass.is_timeshift_enabledTotpTokenClass.previous_otp_offsetTotpTokenClass.resync()TotpTokenClass.timeshiftTotpTokenClass.timestepTotpTokenClass.timewindowTotpTokenClass.update()
- 14.2.1.2.21. U2F Token
- 14.2.1.2.21.1. Enrollment
- 14.2.1.2.21.2. Authentication
- 14.2.1.2.21.3. Implementation
U2fTokenClassU2fTokenClass.api_endpoint()U2fTokenClass.check_otp()U2fTokenClass.client_modeU2fTokenClass.create_challenge()U2fTokenClass.get_class_info()U2fTokenClass.get_class_prefix()U2fTokenClass.get_class_type()U2fTokenClass.get_init_detail()U2fTokenClass.is_challenge_request()U2fTokenClass.update()
- 14.2.1.2.22. Vasco Token
- 14.2.1.2.23. WebAuthn Token
- 14.2.1.2.23.1. Enrollment
- 14.2.1.2.23.2. Authentication
- 14.2.1.2.23.3. Implementation
WebAuthnTokenClassWebAuthnTokenClass.check_otp()WebAuthnTokenClass.check_userless_otp()WebAuthnTokenClass.client_modeWebAuthnTokenClass.create_challenge()WebAuthnTokenClass.create_usernameless_challenge()WebAuthnTokenClass.decrypt_otpkey()WebAuthnTokenClass.get_class_info()WebAuthnTokenClass.get_class_prefix()WebAuthnTokenClass.get_class_type()WebAuthnTokenClass.get_init_detail()WebAuthnTokenClass.get_setting_type()WebAuthnTokenClass.is_challenge_request()WebAuthnTokenClass.update()
- 14.2.1.2.24. Yubico Token
- 14.2.1.2.25. Yubikey Token
YubikeyTokenClassYubikeyTokenClass.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()
TokenClassTokenClass.add_init_details()TokenClass.add_tokengroup()TokenClass.add_tokeninfo()TokenClass.add_user()TokenClass.api_endpoint()TokenClass.authenticate()TokenClass.can_verify_enrollmentTokenClass.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_modeTokenClass.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_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.hKeyRequiredTokenClass.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_enrollableTokenClass.is_orphaned()TokenClass.is_outofband()TokenClass.is_pin_change()TokenClass.is_previous_otp()TokenClass.is_revoked()TokenClass.modeTokenClass.post_success()TokenClass.prepare_verify_enrollment()TokenClass.reset()TokenClass.resync()TokenClass.revoke()TokenClass.rollout_stateTokenClass.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.userTokenClass.using_pinTokenClass.verify_enrollment()
- 14.2.1.2.1. 4 Eyes Token
- 14.2.1.3. Token Functions
add_tokeninfo()assign_token()assign_tokengroup()check_otp()check_realm_pass()check_serial()check_serial_pass()check_token_list()check_user_pass()clob_to_varcharcopy_token_pin()copy_token_realms()copy_token_user()create_challenge_without_token()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_token_by_otp()get_token_owner()get_token_type()get_tokenclass_info()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()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_use_timeshift()set_validity_period_end()set_validity_period_start()token_exist()unassign_token()unassign_tokengroup()weigh_token_type()
- 14.2.1.4. Application Class
- 14.2.1.5. Policy Module
- 14.2.1.5.1. realm and resolver
- 14.2.1.5.2. user
- 14.2.1.5.3. client
- 14.2.1.5.4. time
ACTIONACTION.ADDRESOLVERINRESPONSEACTION.ADDUSERACTION.ADDUSERINRESPONSEACTION.ADMIN_DASHBOARDACTION.APIKEYACTION.APPIMAGEURLACTION.APPLICATION_TOKENTYPEACTION.ASSIGNACTION.AUDITACTION.AUDITPAGESIZEACTION.AUDIT_AGEACTION.AUDIT_DOWNLOADACTION.AUTHITEMSACTION.AUTHMAXFAILACTION.AUTHMAXSUCCESSACTION.AUTHORIZEDACTION.AUTH_CACHEACTION.AUTOASSIGNACTION.CACONNECTORDELETEACTION.CACONNECTORREADACTION.CACONNECTORWRITEACTION.CHALLENGERESPONSEACTION.CHALLENGETEXTACTION.CHALLENGETEXT_FOOTERACTION.CHALLENGETEXT_HEADERACTION.CHANGE_PIN_EVERYACTION.CHANGE_PIN_FIRST_USEACTION.CHANGE_PIN_VIA_VALIDATEACTION.CLIENTTYPEACTION.CONFIGDOCUMENTATIONACTION.COPYTOKENPINACTION.COPYTOKENUSERACTION.CUSTOM_BASELINEACTION.CUSTOM_MENUACTION.DEFAULT_TOKENTYPEACTION.DELETEACTION.DELETEUSERACTION.DELETE_USER_ATTRIBUTESACTION.DELETION_CONFIRMATIONACTION.DIALOG_NO_TOKENACTION.DISABLEACTION.EDUMFASERVERREADACTION.EDUMFASERVERWRITEACTION.EMAILCONFIGACTION.ENABLEACTION.ENCRYPTPINACTION.ENROLLPINACTION.ENROLL_VIA_MULTICHALLENGEACTION.EVENTHANDLINGREADACTION.EVENTHANDLINGWRITEACTION.FORCE_APP_PINACTION.GDPR_LINKACTION.GETCHALLENGESACTION.GETRANDOMACTION.GETSERIALACTION.HIDE_AUDIT_COLUMNSACTION.HIDE_BUTTONSACTION.HIDE_TOKENINFOACTION.HIDE_WELCOMEACTION.IMPORTACTION.INCREASE_FAILCOUNTER_ON_CHALLENGEACTION.LASTAUTHACTION.LOGINMODEACTION.LOGIN_TEXTACTION.LOGOUTTIMEACTION.LOGOUT_REDIRECTACTION.LOSTTOKENACTION.LOSTTOKENPWCONTENTSACTION.LOSTTOKENPWLENACTION.LOSTTOKENVALIDACTION.MACHINELISTACTION.MACHINERESOLVERDELETEACTION.MACHINERESOLVERREADACTION.MACHINERESOLVERWRITEACTION.MACHINETOKENSACTION.MANAGESUBSCRIPTIONACTION.MANGLEACTION.MAXACTIVETOKENUSERACTION.MAXTOKENREALMACTION.MAXTOKENUSERACTION.NODETAILFAILACTION.NODETAILSUCCESSACTION.OTPPINACTION.OTPPINCONTENTSACTION.OTPPINMAXLENACTION.OTPPINMINLENACTION.OTPPINRANDOMACTION.OTPPINSETRANDOMACTION.PASSNOTOKENACTION.PASSNOUSERACTION.PASSTHRUACTION.PASSTHRU_ASSIGNACTION.PASSWORDRESETACTION.PASSWORD_CONTENTSACTION.PASSWORD_LENGTHACTION.PERIODICTASKREADACTION.PERIODICTASKWRITEACTION.PINHANDLINGACTION.POLICYDELETEACTION.POLICYREADACTION.POLICYTEMPLATEURLACTION.POLICYWRITEACTION.PREFERREDCLIENTMODEACTION.RADIUSSERVERREADACTION.RADIUSSERVERWRITEACTION.REALMACTION.REALMDROPDOWNACTION.REGISTERBODYACTION.REGISTRATIONCODE_CONTENTSACTION.REGISTRATIONCODE_LENGTHACTION.REMOTE_USERACTION.REQUIREDEMAILACTION.REQUIRE_DESCRIPTIONACTION.RESETACTION.RESETALLTOKENSACTION.RESOLVERACTION.RESOLVERDELETEACTION.RESOLVERREADACTION.RESOLVERWRITEACTION.RESYNCACTION.RESYNC_VIA_MULTICHALLENGEACTION.REVOKEACTION.SEARCH_ON_ENTERACTION.SERIALACTION.SERVICEID_ADDACTION.SERVICEID_DELETEACTION.SERVICEID_LISTACTION.SETACTION.SETDESCRIPTIONACTION.SETHSMACTION.SETPINACTION.SETRANDOMPINACTION.SETREALMACTION.SETTOKENINFOACTION.SET_USER_ATTRIBUTESACTION.SHOW_ANDROID_AUTHENTICATORACTION.SHOW_CUSTOM_AUTHENTICATORACTION.SHOW_IOS_AUTHENTICATORACTION.SHOW_NODEACTION.SHOW_SEEDACTION.SMSGATEWAYREADACTION.SMSGATEWAYWRITEACTION.SMTPSERVERREADACTION.SMTPSERVERWRITEACTION.STATISTICSDELETEACTION.STATISTICSREADACTION.SYSTEMDELETEACTION.SYSTEMREADACTION.SYSTEMWRITEACTION.TIMEOUT_ACTIONACTION.TOKENGROUPSACTION.TOKENGROUP_ADDACTION.TOKENGROUP_DELETEACTION.TOKENGROUP_LISTACTION.TOKENINFOACTION.TOKENISSUERACTION.TOKENLABELACTION.TOKENLISTACTION.TOKENPAGESIZEACTION.TOKENREALMSACTION.TOKENROLLOVERACTION.TOKENTYPEACTION.TOKENWIZARDACTION.TOKENWIZARD2NDACTION.TRIGGERCHALLENGEACTION.UNASSIGNACTION.UPDATEUSERACTION.USERDETAILSACTION.USERLISTACTION.USERPAGESIZEACTION.VERIFY_ENROLLMENT
ACTIONVALUEAUTHORIZEDAUTOASSIGNVALUECONDITION_CHECKCONDITION_SECTIONGROUPLOGINMODEMAIN_MENUMatchMatchingErrorPolicyClassPolicyClass.check_for_conflicts()PolicyClass.extract_action_values()PolicyClass.filter_policies_by_conditions()PolicyClass.get_action_values()PolicyClass.list_policies()PolicyClass.match_policies()PolicyClass.policiesPolicyClass.ui_get_enroll_tokentypes()PolicyClass.ui_get_main_menus()PolicyClass.ui_get_rights()
REMOTE_USERSCOPETIMEOUT_ACTIONTYPEcheck_pin()delete_all_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()
- 14.2.1.6. Job Queue
- 14.2.1.7. API Policies
- 14.2.1.7.1. Pre Policies
allowed_audit_realm()api_key_required()auditlog_age()check_admin_tokenlist()check_anonymous_user()check_base_action()check_custom_user_attributes()check_external()check_max_token_realm()check_max_token_user()check_otp_pin()check_token_init()check_token_upload()encrypt_pin()enroll_pin()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()legacypushtoken_wait()mangle()mock_fail()mock_success()papertoken_count()prepolicypushtoken_add_config()pushtoken_disable_wait()pushtoken_wait()realmadmin()require_description()required_email()required_piv_attestation()save_client_application_type()set_random_pin()set_realm()sms_identifiers()tantoken_count()twostep_enrollment_activation()twostep_enrollment_parameters()u2ftoken_allowed()u2ftoken_verify_cert()verify_enrollment()webauthntoken_allowed()webauthntoken_auth()webauthntoken_authz()webauthntoken_enroll()webauthntoken_request()
- 14.2.1.7.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()postpolicypostrequestpreferred_client_mode()save_pin_change()sign_response()
- 14.2.1.7.1. Pre Policies
- 14.2.1.8. Policy Decorators
- 14.2.1.9. Event Handler
- 14.2.1.10. SMS Provider
- 14.2.1.1. Users
- 14.2.2. UserIdResolvers
- 14.2.2.1. Base class
UserIdResolverUserIdResolver.add_user()UserIdResolver.checkPass()UserIdResolver.close()UserIdResolver.delete_user()UserIdResolver.editableUserIdResolver.getResolverClassDescriptor()UserIdResolver.getResolverClassType()UserIdResolver.getResolverDescriptor()UserIdResolver.getResolverId()UserIdResolver.getResolverType()UserIdResolver.getUserId()UserIdResolver.getUserInfo()UserIdResolver.getUserList()UserIdResolver.getUsername()UserIdResolver.has_multiple_loginnamesUserIdResolver.loadConfig()UserIdResolver.testconnection()UserIdResolver.update_user()
- 14.2.2.2. PasswdResolver
IdResolverIdResolver.checkPass()IdResolver.checkUserId()IdResolver.checkUserName()IdResolver.getResolverClassDescriptor()IdResolver.getResolverClassType()IdResolver.getResolverDescriptor()IdResolver.getResolverId()IdResolver.getResolverType()IdResolver.getSearchFields()IdResolver.getUserId()IdResolver.getUserInfo()IdResolver.getUserList()IdResolver.getUsername()IdResolver.loadConfig()IdResolver.loadFile()IdResolver.setup()
- 14.2.2.3. LDAPResolver
IdResolverIdResolver.add_user()IdResolver.checkPass()IdResolver.create_connection()IdResolver.create_serverpool()IdResolver.delete_user()IdResolver.editableIdResolver.getResolverClassDescriptor()IdResolver.getResolverClassType()IdResolver.getResolverDescriptor()IdResolver.getResolverId()IdResolver.getResolverType()IdResolver.getUserId()IdResolver.getUserInfo()IdResolver.getUserList()IdResolver.getUsername()IdResolver.get_persistent_serverpool()IdResolver.get_serverpool_instance()IdResolver.has_multiple_loginnamesIdResolver.loadConfig()IdResolver.split_uri()IdResolver.testconnection()IdResolver.update_user()
- 14.2.2.1. Base class
- 14.2.3. Audit log
- 14.2.3.1. Base class
AuditAudit.add_policy()Audit.add_to_log()Audit.audit_entry_to_dict()Audit.available_audit_columnsAudit.csv_generator()Audit.finalize_log()Audit.get_audit_id()Audit.get_count()Audit.get_total()Audit.has_dataAudit.initialize_log()Audit.is_readableAudit.log()Audit.log_token_num()Audit.read_keys()Audit.search()Audit.search_query()
- 14.2.3.2. SQL Audit module
- 14.2.3.1. Base class
- 14.2.4. Monitoring
- 14.2.5. Machine Resolvers
- 14.2.6. PinHandler
14.3. DB level¶
On the DB level you can simply modify all objects.
- 14.3.1. The database model
AdminAuditAuthCacheCAConnectorCAConnectorConfigChallengeClientApplicationConfigCustomUserAttributeEventCounterEventHandlerEventHandlerConditionEventHandlerOptionMachineResolverMachineResolverConfigMachineTokenMachineTokenOptionsMethodsMixinMonitoringStatsPasswordResetPeriodicTaskPeriodicTaskLastRunPeriodicTaskOptionPolicyPolicyConditionRADIUSServerRealmResolverResolverConfigResolverRealmSMSGatewaySMSGatewayOptionSMTPServerServiceidSubscriptionTimestampMethodsMixinTokenTokenInfoTokenOwnerTokenRealmTokenTokengroupTokengroupUserCachecleanup_challenges()eduMFAServerget_machineresolver_id()get_machinetoken_ids()get_token_id()save_config_timestamp()