fusionauth_client 1.49.1 → 1.50.0

data/doc/js/search_index.js

@@ -0,0 +1 @@
+var search_data = {"index":{"searchIndex":["fusionauth","fusionauthclient","action_user()","activate_reactor()","add_user_to_family()","approve_device()","cancel_action()","change_password()","change_password_by_identity()","check_change_password_using_id()","check_change_password_using_jwt()","check_change_password_using_login_id()","client_credentials_grant()","comment_on_user()","complete_web_authn_assertion()","complete_web_authn_login()","complete_web_authn_registration()","create_api_key()","create_application()","create_application_role()","create_audit_log()","create_connector()","create_consent()","create_email_template()","create_entity()","create_entity_type()","create_entity_type_permission()","create_family()","create_form()","create_form_field()","create_group()","create_group_members()","create_identity_provider()","create_ip_access_control_list()","create_lambda()","create_message_template()","create_messenger()","create_o_auth_scope()","create_tenant()","create_theme()","create_user()","create_user_action()","create_user_action_reason()","create_user_consent()","create_user_link()","create_webhook()","deactivate_application()","deactivate_reactor()","deactivate_user()","deactivate_user_action()","deactivate_users()","deactivate_users_by_ids()","delete_api_key()","delete_application()","delete_application_role()","delete_connector()","delete_consent()","delete_email_template()","delete_entity()","delete_entity_grant()","delete_entity_type()","delete_entity_type_permission()","delete_form()","delete_form_field()","delete_group()","delete_group_members()","delete_identity_provider()","delete_ip_access_control_list()","delete_key()","delete_lambda()","delete_message_template()","delete_messenger()","delete_o_auth_scope()","delete_registration()","delete_registration_with_request()","delete_tenant()","delete_tenant_async()","delete_tenant_with_request()","delete_theme()","delete_user()","delete_user_action()","delete_user_action_reason()","delete_user_link()","delete_user_with_request()","delete_users()","delete_users_by_query()","delete_web_authn_credential()","delete_webhook()","disable_two_factor()","disable_two_factor_with_request()","enable_two_factor()","exchange_o_auth_code_for_access_token()","exchange_o_auth_code_for_access_token_using_pkce()","exchange_refresh_token_for_access_token()","exchange_refresh_token_for_jwt()","exchange_user_credentials_for_access_token()","forgot_password()","generate_email_verification_id()","generate_key()","generate_registration_verification_id()","generate_two_factor_recovery_codes()","generate_two_factor_secret()","generate_two_factor_secret_using_jwt()","identity_provider_login()","import_key()","import_refresh_tokens()","import_users()","import_web_authn_credential()","introspect_access_token()","introspect_client_credentials_access_token()","issue_jwt()","login()","login_ping()","login_ping_with_request()","logout()","logout_with_request()","lookup_identity_provider()","modify_action()","new()","passwordless_login()","patch_api_key()","patch_application()","patch_application_role()","patch_connector()","patch_consent()","patch_email_template()","patch_entity_type()","patch_group()","patch_identity_provider()","patch_integrations()","patch_lambda()","patch_message_template()","patch_messenger()","patch_o_auth_scope()","patch_registration()","patch_system_configuration()","patch_tenant()","patch_theme()","patch_user()","patch_user_action()","patch_user_action_reason()","patch_user_consent()","reactivate_application()","reactivate_user()","reactivate_user_action()","reconcile_jwt()","refresh_entity_search_index()","refresh_user_search_index()","regenerate_reactor_keys()","register()","reindex()","remove_user_from_family()","resend_email_verification()","resend_email_verification_with_application_template()","resend_registration_verification()","retrieve_action()","retrieve_actions()","retrieve_actions_preventing_login()","retrieve_active_actions()","retrieve_api_key()","retrieve_application()","retrieve_applications()","retrieve_audit_log()","retrieve_connector()","retrieve_connectors()","retrieve_consent()","retrieve_consents()","retrieve_daily_active_report()","retrieve_email_template()","retrieve_email_template_preview()","retrieve_email_templates()","retrieve_entity()","retrieve_entity_grant()","retrieve_entity_type()","retrieve_entity_types()","retrieve_event_log()","retrieve_families()","retrieve_family_members_by_family_id()","retrieve_form()","retrieve_form_field()","retrieve_form_fields()","retrieve_forms()","retrieve_group()","retrieve_groups()","retrieve_identity_provider()","retrieve_identity_provider_by_type()","retrieve_identity_providers()","retrieve_inactive_actions()","retrieve_inactive_applications()","retrieve_inactive_user_actions()","retrieve_integration()","retrieve_ip_access_control_list()","retrieve_json_web_key_set()","retrieve_jwt_public_key()","retrieve_jwt_public_key_by_application_id()","retrieve_jwt_public_keys()","retrieve_key()","retrieve_keys()","retrieve_lambda()","retrieve_lambdas()","retrieve_lambdas_by_type()","retrieve_login_report()","retrieve_message_template()","retrieve_message_template_preview()","retrieve_message_templates()","retrieve_messenger()","retrieve_messengers()","retrieve_monthly_active_report()","retrieve_o_auth_scope()","retrieve_oauth_configuration()","retrieve_open_id_configuration()","retrieve_password_validation_rules()","retrieve_password_validation_rules_with_tenant_id()","retrieve_pending_children()","retrieve_pending_link()","retrieve_reactor_metrics()","retrieve_reactor_status()","retrieve_recent_logins()","retrieve_refresh_token_by_id()","retrieve_refresh_tokens()","retrieve_registration()","retrieve_registration_report()","retrieve_reindex_status()","retrieve_system_configuration()","retrieve_tenant()","retrieve_tenants()","retrieve_theme()","retrieve_themes()","retrieve_total_report()","retrieve_two_factor_recovery_codes()","retrieve_two_factor_status()","retrieve_user()","retrieve_user_action()","retrieve_user_action_reason()","retrieve_user_action_reasons()","retrieve_user_actions()","retrieve_user_by_change_password_id()","retrieve_user_by_email()","retrieve_user_by_login_id()","retrieve_user_by_username()","retrieve_user_by_verification_id()","retrieve_user_code()","retrieve_user_code_using_api_key()","retrieve_user_comments()","retrieve_user_consent()","retrieve_user_consents()","retrieve_user_info_from_access_token()","retrieve_user_link()","retrieve_user_links_by_user_id()","retrieve_user_login_report()","retrieve_user_login_report_by_login_id()","retrieve_user_recent_logins()","retrieve_user_using_jwt()","retrieve_version()","retrieve_web_authn_credential()","retrieve_web_authn_credentials_for_user()","retrieve_webhook()","retrieve_webhooks()","revoke_refresh_token()","revoke_refresh_token_by_id()","revoke_refresh_token_by_token()","revoke_refresh_tokens_by_application_id()","revoke_refresh_tokens_by_user_id()","revoke_refresh_tokens_by_user_id_for_application()","revoke_refresh_tokens_with_request()","revoke_user_consent()","search_applications()","search_audit_logs()","search_consents()","search_email_templates()","search_entities()","search_entities_by_ids()","search_entity_grants()","search_entity_types()","search_event_logs()","search_group_members()","search_groups()","search_identity_providers()","search_ip_access_control_lists()","search_keys()","search_lambdas()","search_login_records()","search_tenants()","search_themes()","search_user_comments()","search_users()","search_users_by_ids()","search_users_by_query()","search_users_by_query_string()","search_webhooks()","send_email()","send_family_request_email()","send_passwordless_code()","send_two_factor_code()","send_two_factor_code_for_enable_disable()","send_two_factor_code_for_login()","send_two_factor_code_for_login_using_method()","set_tenant_id()","start_identity_provider_login()","start_passwordless_login()","start_two_factor_login()","start_web_authn_login()","start_web_authn_registration()","two_factor_login()","update_api_key()","update_application()","update_application_role()","update_connector()","update_consent()","update_email_template()","update_entity()","update_entity_type()","update_entity_type_permission()","update_form()","update_form_field()","update_group()","update_group_members()","update_identity_provider()","update_integrations()","update_ip_access_control_list()","update_key()","update_lambda()","update_message_template()","update_messenger()","update_o_auth_scope()","update_registration()","update_system_configuration()","update_tenant()","update_theme()","update_user()","update_user_action()","update_user_action_reason()","update_user_consent()","update_webhook()","upsert_entity_grant()","validate_device()","validate_jwt()","vend_jwt()","verify_email()","verify_email_address()","verify_email_address_by_user_id()","verify_registration()","verify_user_registration()"],"longSearchIndex":["fusionauth","fusionauth::fusionauthclient","fusionauth::fusionauthclient#action_user()","fusionauth::fusionauthclient#activate_reactor()","fusionauth::fusionauthclient#add_user_to_family()","fusionauth::fusionauthclient#approve_device()","fusionauth::fusionauthclient#cancel_action()","fusionauth::fusionauthclient#change_password()","fusionauth::fusionauthclient#change_password_by_identity()","fusionauth::fusionauthclient#check_change_password_using_id()","fusionauth::fusionauthclient#check_change_password_using_jwt()","fusionauth::fusionauthclient#check_change_password_using_login_id()","fusionauth::fusionauthclient#client_credentials_grant()","fusionauth::fusionauthclient#comment_on_user()","fusionauth::fusionauthclient#complete_web_authn_assertion()","fusionauth::fusionauthclient#complete_web_authn_login()","fusionauth::fusionauthclient#complete_web_authn_registration()","fusionauth::fusionauthclient#create_api_key()","fusionauth::fusionauthclient#create_application()","fusionauth::fusionauthclient#create_application_role()","fusionauth::fusionauthclient#create_audit_log()","fusionauth::fusionauthclient#create_connector()","fusionauth::fusionauthclient#create_consent()","fusionauth::fusionauthclient#create_email_template()","fusionauth::fusionauthclient#create_entity()","fusionauth::fusionauthclient#create_entity_type()","fusionauth::fusionauthclient#create_entity_type_permission()","fusionauth::fusionauthclient#create_family()","fusionauth::fusionauthclient#create_form()","fusionauth::fusionauthclient#create_form_field()","fusionauth::fusionauthclient#create_group()","fusionauth::fusionauthclient#create_group_members()","fusionauth::fusionauthclient#create_identity_provider()","fusionauth::fusionauthclient#create_ip_access_control_list()","fusionauth::fusionauthclient#create_lambda()","fusionauth::fusionauthclient#create_message_template()","fusionauth::fusionauthclient#create_messenger()","fusionauth::fusionauthclient#create_o_auth_scope()","fusionauth::fusionauthclient#create_tenant()","fusionauth::fusionauthclient#create_theme()","fusionauth::fusionauthclient#create_user()","fusionauth::fusionauthclient#create_user_action()","fusionauth::fusionauthclient#create_user_action_reason()","fusionauth::fusionauthclient#create_user_consent()","fusionauth::fusionauthclient#create_user_link()","fusionauth::fusionauthclient#create_webhook()","fusionauth::fusionauthclient#deactivate_application()","fusionauth::fusionauthclient#deactivate_reactor()","fusionauth::fusionauthclient#deactivate_user()","fusionauth::fusionauthclient#deactivate_user_action()","fusionauth::fusionauthclient#deactivate_users()","fusionauth::fusionauthclient#deactivate_users_by_ids()","fusionauth::fusionauthclient#delete_api_key()","fusionauth::fusionauthclient#delete_application()","fusionauth::fusionauthclient#delete_application_role()","fusionauth::fusionauthclient#delete_connector()","fusionauth::fusionauthclient#delete_consent()","fusionauth::fusionauthclient#delete_email_template()","fusionauth::fusionauthclient#delete_entity()","fusionauth::fusionauthclient#delete_entity_grant()","fusionauth::fusionauthclient#delete_entity_type()","fusionauth::fusionauthclient#delete_entity_type_permission()","fusionauth::fusionauthclient#delete_form()","fusionauth::fusionauthclient#delete_form_field()","fusionauth::fusionauthclient#delete_group()","fusionauth::fusionauthclient#delete_group_members()","fusionauth::fusionauthclient#delete_identity_provider()","fusionauth::fusionauthclient#delete_ip_access_control_list()","fusionauth::fusionauthclient#delete_key()","fusionauth::fusionauthclient#delete_lambda()","fusionauth::fusionauthclient#delete_message_template()","fusionauth::fusionauthclient#delete_messenger()","fusionauth::fusionauthclient#delete_o_auth_scope()","fusionauth::fusionauthclient#delete_registration()","fusionauth::fusionauthclient#delete_registration_with_request()","fusionauth::fusionauthclient#delete_tenant()","fusionauth::fusionauthclient#delete_tenant_async()","fusionauth::fusionauthclient#delete_tenant_with_request()","fusionauth::fusionauthclient#delete_theme()","fusionauth::fusionauthclient#delete_user()","fusionauth::fusionauthclient#delete_user_action()","fusionauth::fusionauthclient#delete_user_action_reason()","fusionauth::fusionauthclient#delete_user_link()","fusionauth::fusionauthclient#delete_user_with_request()","fusionauth::fusionauthclient#delete_users()","fusionauth::fusionauthclient#delete_users_by_query()","fusionauth::fusionauthclient#delete_web_authn_credential()","fusionauth::fusionauthclient#delete_webhook()","fusionauth::fusionauthclient#disable_two_factor()","fusionauth::fusionauthclient#disable_two_factor_with_request()","fusionauth::fusionauthclient#enable_two_factor()","fusionauth::fusionauthclient#exchange_o_auth_code_for_access_token()","fusionauth::fusionauthclient#exchange_o_auth_code_for_access_token_using_pkce()","fusionauth::fusionauthclient#exchange_refresh_token_for_access_token()","fusionauth::fusionauthclient#exchange_refresh_token_for_jwt()","fusionauth::fusionauthclient#exchange_user_credentials_for_access_token()","fusionauth::fusionauthclient#forgot_password()","fusionauth::fusionauthclient#generate_email_verification_id()","fusionauth::fusionauthclient#generate_key()","fusionauth::fusionauthclient#generate_registration_verification_id()","fusionauth::fusionauthclient#generate_two_factor_recovery_codes()","fusionauth::fusionauthclient#generate_two_factor_secret()","fusionauth::fusionauthclient#generate_two_factor_secret_using_jwt()","fusionauth::fusionauthclient#identity_provider_login()","fusionauth::fusionauthclient#import_key()","fusionauth::fusionauthclient#import_refresh_tokens()","fusionauth::fusionauthclient#import_users()","fusionauth::fusionauthclient#import_web_authn_credential()","fusionauth::fusionauthclient#introspect_access_token()","fusionauth::fusionauthclient#introspect_client_credentials_access_token()","fusionauth::fusionauthclient#issue_jwt()","fusionauth::fusionauthclient#login()","fusionauth::fusionauthclient#login_ping()","fusionauth::fusionauthclient#login_ping_with_request()","fusionauth::fusionauthclient#logout()","fusionauth::fusionauthclient#logout_with_request()","fusionauth::fusionauthclient#lookup_identity_provider()","fusionauth::fusionauthclient#modify_action()","fusionauth::fusionauthclient::new()","fusionauth::fusionauthclient#passwordless_login()","fusionauth::fusionauthclient#patch_api_key()","fusionauth::fusionauthclient#patch_application()","fusionauth::fusionauthclient#patch_application_role()","fusionauth::fusionauthclient#patch_connector()","fusionauth::fusionauthclient#patch_consent()","fusionauth::fusionauthclient#patch_email_template()","fusionauth::fusionauthclient#patch_entity_type()","fusionauth::fusionauthclient#patch_group()","fusionauth::fusionauthclient#patch_identity_provider()","fusionauth::fusionauthclient#patch_integrations()","fusionauth::fusionauthclient#patch_lambda()","fusionauth::fusionauthclient#patch_message_template()","fusionauth::fusionauthclient#patch_messenger()","fusionauth::fusionauthclient#patch_o_auth_scope()","fusionauth::fusionauthclient#patch_registration()","fusionauth::fusionauthclient#patch_system_configuration()","fusionauth::fusionauthclient#patch_tenant()","fusionauth::fusionauthclient#patch_theme()","fusionauth::fusionauthclient#patch_user()","fusionauth::fusionauthclient#patch_user_action()","fusionauth::fusionauthclient#patch_user_action_reason()","fusionauth::fusionauthclient#patch_user_consent()","fusionauth::fusionauthclient#reactivate_application()","fusionauth::fusionauthclient#reactivate_user()","fusionauth::fusionauthclient#reactivate_user_action()","fusionauth::fusionauthclient#reconcile_jwt()","fusionauth::fusionauthclient#refresh_entity_search_index()","fusionauth::fusionauthclient#refresh_user_search_index()","fusionauth::fusionauthclient#regenerate_reactor_keys()","fusionauth::fusionauthclient#register()","fusionauth::fusionauthclient#reindex()","fusionauth::fusionauthclient#remove_user_from_family()","fusionauth::fusionauthclient#resend_email_verification()","fusionauth::fusionauthclient#resend_email_verification_with_application_template()","fusionauth::fusionauthclient#resend_registration_verification()","fusionauth::fusionauthclient#retrieve_action()","fusionauth::fusionauthclient#retrieve_actions()","fusionauth::fusionauthclient#retrieve_actions_preventing_login()","fusionauth::fusionauthclient#retrieve_active_actions()","fusionauth::fusionauthclient#retrieve_api_key()","fusionauth::fusionauthclient#retrieve_application()","fusionauth::fusionauthclient#retrieve_applications()","fusionauth::fusionauthclient#retrieve_audit_log()","fusionauth::fusionauthclient#retrieve_connector()","fusionauth::fusionauthclient#retrieve_connectors()","fusionauth::fusionauthclient#retrieve_consent()","fusionauth::fusionauthclient#retrieve_consents()","fusionauth::fusionauthclient#retrieve_daily_active_report()","fusionauth::fusionauthclient#retrieve_email_template()","fusionauth::fusionauthclient#retrieve_email_template_preview()","fusionauth::fusionauthclient#retrieve_email_templates()","fusionauth::fusionauthclient#retrieve_entity()","fusionauth::fusionauthclient#retrieve_entity_grant()","fusionauth::fusionauthclient#retrieve_entity_type()","fusionauth::fusionauthclient#retrieve_entity_types()","fusionauth::fusionauthclient#retrieve_event_log()","fusionauth::fusionauthclient#retrieve_families()","fusionauth::fusionauthclient#retrieve_family_members_by_family_id()","fusionauth::fusionauthclient#retrieve_form()","fusionauth::fusionauthclient#retrieve_form_field()","fusionauth::fusionauthclient#retrieve_form_fields()","fusionauth::fusionauthclient#retrieve_forms()","fusionauth::fusionauthclient#retrieve_group()","fusionauth::fusionauthclient#retrieve_groups()","fusionauth::fusionauthclient#retrieve_identity_provider()","fusionauth::fusionauthclient#retrieve_identity_provider_by_type()","fusionauth::fusionauthclient#retrieve_identity_providers()","fusionauth::fusionauthclient#retrieve_inactive_actions()","fusionauth::fusionauthclient#retrieve_inactive_applications()","fusionauth::fusionauthclient#retrieve_inactive_user_actions()","fusionauth::fusionauthclient#retrieve_integration()","fusionauth::fusionauthclient#retrieve_ip_access_control_list()","fusionauth::fusionauthclient#retrieve_json_web_key_set()","fusionauth::fusionauthclient#retrieve_jwt_public_key()","fusionauth::fusionauthclient#retrieve_jwt_public_key_by_application_id()","fusionauth::fusionauthclient#retrieve_jwt_public_keys()","fusionauth::fusionauthclient#retrieve_key()","fusionauth::fusionauthclient#retrieve_keys()","fusionauth::fusionauthclient#retrieve_lambda()","fusionauth::fusionauthclient#retrieve_lambdas()","fusionauth::fusionauthclient#retrieve_lambdas_by_type()","fusionauth::fusionauthclient#retrieve_login_report()","fusionauth::fusionauthclient#retrieve_message_template()","fusionauth::fusionauthclient#retrieve_message_template_preview()","fusionauth::fusionauthclient#retrieve_message_templates()","fusionauth::fusionauthclient#retrieve_messenger()","fusionauth::fusionauthclient#retrieve_messengers()","fusionauth::fusionauthclient#retrieve_monthly_active_report()","fusionauth::fusionauthclient#retrieve_o_auth_scope()","fusionauth::fusionauthclient#retrieve_oauth_configuration()","fusionauth::fusionauthclient#retrieve_open_id_configuration()","fusionauth::fusionauthclient#retrieve_password_validation_rules()","fusionauth::fusionauthclient#retrieve_password_validation_rules_with_tenant_id()","fusionauth::fusionauthclient#retrieve_pending_children()","fusionauth::fusionauthclient#retrieve_pending_link()","fusionauth::fusionauthclient#retrieve_reactor_metrics()","fusionauth::fusionauthclient#retrieve_reactor_status()","fusionauth::fusionauthclient#retrieve_recent_logins()","fusionauth::fusionauthclient#retrieve_refresh_token_by_id()","fusionauth::fusionauthclient#retrieve_refresh_tokens()","fusionauth::fusionauthclient#retrieve_registration()","fusionauth::fusionauthclient#retrieve_registration_report()","fusionauth::fusionauthclient#retrieve_reindex_status()","fusionauth::fusionauthclient#retrieve_system_configuration()","fusionauth::fusionauthclient#retrieve_tenant()","fusionauth::fusionauthclient#retrieve_tenants()","fusionauth::fusionauthclient#retrieve_theme()","fusionauth::fusionauthclient#retrieve_themes()","fusionauth::fusionauthclient#retrieve_total_report()","fusionauth::fusionauthclient#retrieve_two_factor_recovery_codes()","fusionauth::fusionauthclient#retrieve_two_factor_status()","fusionauth::fusionauthclient#retrieve_user()","fusionauth::fusionauthclient#retrieve_user_action()","fusionauth::fusionauthclient#retrieve_user_action_reason()","fusionauth::fusionauthclient#retrieve_user_action_reasons()","fusionauth::fusionauthclient#retrieve_user_actions()","fusionauth::fusionauthclient#retrieve_user_by_change_password_id()","fusionauth::fusionauthclient#retrieve_user_by_email()","fusionauth::fusionauthclient#retrieve_user_by_login_id()","fusionauth::fusionauthclient#retrieve_user_by_username()","fusionauth::fusionauthclient#retrieve_user_by_verification_id()","fusionauth::fusionauthclient#retrieve_user_code()","fusionauth::fusionauthclient#retrieve_user_code_using_api_key()","fusionauth::fusionauthclient#retrieve_user_comments()","fusionauth::fusionauthclient#retrieve_user_consent()","fusionauth::fusionauthclient#retrieve_user_consents()","fusionauth::fusionauthclient#retrieve_user_info_from_access_token()","fusionauth::fusionauthclient#retrieve_user_link()","fusionauth::fusionauthclient#retrieve_user_links_by_user_id()","fusionauth::fusionauthclient#retrieve_user_login_report()","fusionauth::fusionauthclient#retrieve_user_login_report_by_login_id()","fusionauth::fusionauthclient#retrieve_user_recent_logins()","fusionauth::fusionauthclient#retrieve_user_using_jwt()","fusionauth::fusionauthclient#retrieve_version()","fusionauth::fusionauthclient#retrieve_web_authn_credential()","fusionauth::fusionauthclient#retrieve_web_authn_credentials_for_user()","fusionauth::fusionauthclient#retrieve_webhook()","fusionauth::fusionauthclient#retrieve_webhooks()","fusionauth::fusionauthclient#revoke_refresh_token()","fusionauth::fusionauthclient#revoke_refresh_token_by_id()","fusionauth::fusionauthclient#revoke_refresh_token_by_token()","fusionauth::fusionauthclient#revoke_refresh_tokens_by_application_id()","fusionauth::fusionauthclient#revoke_refresh_tokens_by_user_id()","fusionauth::fusionauthclient#revoke_refresh_tokens_by_user_id_for_application()","fusionauth::fusionauthclient#revoke_refresh_tokens_with_request()","fusionauth::fusionauthclient#revoke_user_consent()","fusionauth::fusionauthclient#search_applications()","fusionauth::fusionauthclient#search_audit_logs()","fusionauth::fusionauthclient#search_consents()","fusionauth::fusionauthclient#search_email_templates()","fusionauth::fusionauthclient#search_entities()","fusionauth::fusionauthclient#search_entities_by_ids()","fusionauth::fusionauthclient#search_entity_grants()","fusionauth::fusionauthclient#search_entity_types()","fusionauth::fusionauthclient#search_event_logs()","fusionauth::fusionauthclient#search_group_members()","fusionauth::fusionauthclient#search_groups()","fusionauth::fusionauthclient#search_identity_providers()","fusionauth::fusionauthclient#search_ip_access_control_lists()","fusionauth::fusionauthclient#search_keys()","fusionauth::fusionauthclient#search_lambdas()","fusionauth::fusionauthclient#search_login_records()","fusionauth::fusionauthclient#search_tenants()","fusionauth::fusionauthclient#search_themes()","fusionauth::fusionauthclient#search_user_comments()","fusionauth::fusionauthclient#search_users()","fusionauth::fusionauthclient#search_users_by_ids()","fusionauth::fusionauthclient#search_users_by_query()","fusionauth::fusionauthclient#search_users_by_query_string()","fusionauth::fusionauthclient#search_webhooks()","fusionauth::fusionauthclient#send_email()","fusionauth::fusionauthclient#send_family_request_email()","fusionauth::fusionauthclient#send_passwordless_code()","fusionauth::fusionauthclient#send_two_factor_code()","fusionauth::fusionauthclient#send_two_factor_code_for_enable_disable()","fusionauth::fusionauthclient#send_two_factor_code_for_login()","fusionauth::fusionauthclient#send_two_factor_code_for_login_using_method()","fusionauth::fusionauthclient#set_tenant_id()","fusionauth::fusionauthclient#start_identity_provider_login()","fusionauth::fusionauthclient#start_passwordless_login()","fusionauth::fusionauthclient#start_two_factor_login()","fusionauth::fusionauthclient#start_web_authn_login()","fusionauth::fusionauthclient#start_web_authn_registration()","fusionauth::fusionauthclient#two_factor_login()","fusionauth::fusionauthclient#update_api_key()","fusionauth::fusionauthclient#update_application()","fusionauth::fusionauthclient#update_application_role()","fusionauth::fusionauthclient#update_connector()","fusionauth::fusionauthclient#update_consent()","fusionauth::fusionauthclient#update_email_template()","fusionauth::fusionauthclient#update_entity()","fusionauth::fusionauthclient#update_entity_type()","fusionauth::fusionauthclient#update_entity_type_permission()","fusionauth::fusionauthclient#update_form()","fusionauth::fusionauthclient#update_form_field()","fusionauth::fusionauthclient#update_group()","fusionauth::fusionauthclient#update_group_members()","fusionauth::fusionauthclient#update_identity_provider()","fusionauth::fusionauthclient#update_integrations()","fusionauth::fusionauthclient#update_ip_access_control_list()","fusionauth::fusionauthclient#update_key()","fusionauth::fusionauthclient#update_lambda()","fusionauth::fusionauthclient#update_message_template()","fusionauth::fusionauthclient#update_messenger()","fusionauth::fusionauthclient#update_o_auth_scope()","fusionauth::fusionauthclient#update_registration()","fusionauth::fusionauthclient#update_system_configuration()","fusionauth::fusionauthclient#update_tenant()","fusionauth::fusionauthclient#update_theme()","fusionauth::fusionauthclient#update_user()","fusionauth::fusionauthclient#update_user_action()","fusionauth::fusionauthclient#update_user_action_reason()","fusionauth::fusionauthclient#update_user_consent()","fusionauth::fusionauthclient#update_webhook()","fusionauth::fusionauthclient#upsert_entity_grant()","fusionauth::fusionauthclient#validate_device()","fusionauth::fusionauthclient#validate_jwt()","fusionauth::fusionauthclient#vend_jwt()","fusionauth::fusionauthclient#verify_email()","fusionauth::fusionauthclient#verify_email_address()","fusionauth::fusionauthclient#verify_email_address_by_user_id()","fusionauth::fusionauthclient#verify_registration()","fusionauth::fusionauthclient#verify_user_registration()"],"info":[["FusionAuth","","FusionAuth.html","","<p>Copyright © 2018-2023, FusionAuth, All Rights Reserved\n<p>Licensed under the Apache License, Version 2.0 …\n"],["FusionAuth::FusionAuthClient","","FusionAuth/FusionAuthClient.html","","<p>This class is the the Ruby client library for the FusionAuth CIAM Platform {fusionauth.io}\n<p>Each method …\n"],["action_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-action_user","(request)","<p>Takes an action on a user. The user being actioned is called the “actionee” and the user taking …\n"],["activate_reactor","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-activate_reactor","(request)","<p>Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments) …\n"],["add_user_to_family","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-add_user_to_family","(family_id, request)","<p>Adds a user to an existing family. The family Id must be specified.\n<p>@param family_id [string] The Id of …\n"],["approve_device","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-approve_device","(client_id, client_secret, token, user_code)","<p>Approve a device grant.\n<p>@param client_id [string] (Optional) The unique client identifier. The client …\n"],["cancel_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-cancel_action","(action_id, request)","<p>Cancels the user action.\n<p>@param action_id [string] The action Id of the action to cancel. @param request …\n"],["change_password","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-change_password","(change_password_id, request)","<p>Changes a user&#39;s password using the change password Id. This usually occurs after an email has been …\n"],["change_password_by_identity","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-change_password_by_identity","(request)","<p>Changes a user&#39;s password using their identity (loginId and password). Using a loginId instead of …\n"],["check_change_password_using_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-check_change_password_using_id","(change_password_id)","<p>Check to see if the user must obtain a Trust Token Id in order to complete a change password request. …\n"],["check_change_password_using_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-check_change_password_using_jwt","(encoded_jwt)","<p>Check to see if the user must obtain a Trust Token Id in order to complete a change password request. …\n"],["check_change_password_using_login_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-check_change_password_using_login_id","(login_id)","<p>Check to see if the user must obtain a Trust Request Id in order to complete a change password request. …\n"],["client_credentials_grant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-client_credentials_grant","(client_id, client_secret, scope)","<p>Make a Client Credentials grant request to obtain an access token.\n<p>@param client_id [string] (Optional …\n"],["comment_on_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-comment_on_user","(request)","<p>Adds a comment to the user&#39;s account.\n<p>@param request [OpenStruct, Hash] The request object that contains …\n"],["complete_web_authn_assertion","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-complete_web_authn_assertion","(request)","<p>Complete a WebAuthn authentication ceremony by validating the signature against the previously generated …\n"],["complete_web_authn_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-complete_web_authn_login","(request)","<p>Complete a WebAuthn authentication ceremony by validating the signature against the previously generated …\n"],["complete_web_authn_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-complete_web_authn_registration","(request)","<p>Complete a WebAuthn registration ceremony by validating the client request and saving the new credential …\n"],["create_api_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_api_key","(key_id, request)","<p>Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. …\n"],["create_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_application","(application_id, request)","<p>Creates an application. You can optionally specify an Id for the application, if not provided one will …\n"],["create_application_role","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_application_role","(application_id, role_id, request)","<p>Creates a new role for an application. You must specify the Id of the application you are creating the …\n"],["create_audit_log","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_audit_log","(request)","<p>Creates an audit log with the message and user name (usually an email). Audit logs should be written …\n"],["create_connector","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_connector","(connector_id, request)","<p>Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be …\n"],["create_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_consent","(consent_id, request)","<p>Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one …\n"],["create_email_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_email_template","(email_template_id, request)","<p>Creates an email template. You can optionally specify an Id for the template, if not provided one will …\n"],["create_entity","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_entity","(entity_id, request)","<p>Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated. …\n"],["create_entity_type","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_entity_type","(entity_type_id, request)","<p>Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will …\n"],["create_entity_type_permission","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_entity_type_permission","(entity_type_id, permission_id, request)","<p>Creates a new permission for an entity type. You must specify the Id of the entity type you are creating …\n"],["create_family","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_family","(family_id, request)","<p>Creates a family with the user Id in the request as the owner and sole member of the family. You can …\n"],["create_form","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_form","(form_id, request)","<p>Creates a form.  You can optionally specify an Id for the form, if not provided one will be generated. …\n"],["create_form_field","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_form_field","(field_id, request)","<p>Creates a form field.  You can optionally specify an Id for the form, if not provided one will be generated. …\n"],["create_group","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_group","(group_id, request)","<p>Creates a group. You can optionally specify an Id for the group, if not provided one will be generated. …\n"],["create_group_members","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_group_members","(request)","<p>Creates a member in a group.\n<p>@param request [OpenStruct, Hash] The request object that contains all the …\n"],["create_identity_provider","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_identity_provider","(identity_provider_id, request)","<p>Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided …\n"],["create_ip_access_control_list","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_ip_access_control_list","(access_control_list_id, request)","<p>Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is …\n"],["create_lambda","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_lambda","(lambda_id, request)","<p>Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated. …\n"],["create_message_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_message_template","(message_template_id, request)","<p>Creates an message template. You can optionally specify an Id for the template, if not provided one will …\n"],["create_messenger","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_messenger","(messenger_id, request)","<p>Creates a messenger.  You can optionally specify an Id for the messenger, if not provided one will be …\n"],["create_o_auth_scope","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_o_auth_scope","(application_id, scope_id, request)","<p>Creates a new custom OAuth scope for an application. You must specify the Id of the application you are …\n"],["create_tenant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_tenant","(tenant_id, request)","<p>Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated. …\n"],["create_theme","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_theme","(theme_id, request)","<p>Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated. …\n"],["create_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_user","(user_id, request)","<p>Creates a user. You can optionally specify an Id for the user, if not provided one will be generated. …\n"],["create_user_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_user_action","(user_action_id, request)","<p>Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime …\n"],["create_user_action_reason","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_user_action_reason","(user_action_reason_id, request)","<p>Creates a user reason. This user action reason cannot be used when actioning a user until this call completes …\n"],["create_user_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_user_consent","(user_consent_id, request)","<p>Creates a single User consent.\n<p>@param user_consent_id [string] (Optional) The Id for the User consent. …\n"],["create_user_link","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_user_link","(request)","<p>Link an external user from a 3rd party identity provider to a FusionAuth user.\n<p>@param request [OpenStruct, …\n"],["create_webhook","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-create_webhook","(webhook_id, request)","<p>Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated. …\n"],["deactivate_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-deactivate_application","(application_id)","<p>Deactivates the application with the given Id.\n<p>@param application_id [string] The Id of the application …\n"],["deactivate_reactor","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-deactivate_reactor","()","<p>Deactivates the FusionAuth Reactor.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["deactivate_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-deactivate_user","(user_id)","<p>Deactivates the user with the given Id.\n<p>@param user_id [string] The Id of the user to deactivate. @return …\n"],["deactivate_user_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-deactivate_user_action","(user_action_id)","<p>Deactivates the user action with the given Id.\n<p>@param user_action_id [string] The Id of the user action …\n"],["deactivate_users","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-deactivate_users","(user_ids)","<p>Deactivates the users with the given ids.\n<p>@param user_ids [Array] The ids of the users to deactivate. …\n"],["deactivate_users_by_ids","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-deactivate_users_by_ids","(user_ids)","<p>Deactivates the users with the given ids.\n<p>@param user_ids [Array] The ids of the users to deactivate. …\n"],["delete_api_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_api_key","(key_id)","<p>Deletes the API key for the given Id.\n<p>@param key_id [string] The Id of the authentication API key to delete. …\n"],["delete_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_application","(application_id)","<p>Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. …\n"],["delete_application_role","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_application_role","(application_id, role_id)","<p>Hard deletes an application role. This is a dangerous operation and should not be used in most circumstances. …\n"],["delete_connector","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_connector","(connector_id)","<p>Deletes the connector for the given Id.\n<p>@param connector_id [string] The Id of the connector to delete. …\n"],["delete_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_consent","(consent_id)","<p>Deletes the consent for the given Id.\n<p>@param consent_id [string] The Id of the consent to delete. @return …\n"],["delete_email_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_email_template","(email_template_id)","<p>Deletes the email template for the given Id.\n<p>@param email_template_id [string] The Id of the email template …\n"],["delete_entity","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_entity","(entity_id)","<p>Deletes the Entity for the given Id.\n<p>@param entity_id [string] The Id of the Entity to delete. @return …\n"],["delete_entity_grant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_entity_grant","(entity_id, recipient_entity_id, user_id)","<p>Deletes an Entity Grant for the given User or Entity.\n<p>@param entity_id [string] The Id of the Entity that …\n"],["delete_entity_type","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_entity_type","(entity_type_id)","<p>Deletes the Entity Type for the given Id.\n<p>@param entity_type_id [string] The Id of the Entity Type to …\n"],["delete_entity_type_permission","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_entity_type_permission","(entity_type_id, permission_id)","<p>Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. …\n"],["delete_form","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_form","(form_id)","<p>Deletes the form for the given Id.\n<p>@param form_id [string] The Id of the form to delete. @return [FusionAuth::ClientResponse] …\n"],["delete_form_field","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_form_field","(field_id)","<p>Deletes the form field for the given Id.\n<p>@param field_id [string] The Id of the form field to delete. …\n"],["delete_group","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_group","(group_id)","<p>Deletes the group for the given Id.\n<p>@param group_id [string] The Id of the group to delete. @return [FusionAuth::ClientResponse] …\n"],["delete_group_members","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_group_members","(request)","<p>Removes users as members of a group.\n<p>@param request [OpenStruct, Hash] The member request that contains …\n"],["delete_identity_provider","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_identity_provider","(identity_provider_id)","<p>Deletes the identity provider for the given Id.\n<p>@param identity_provider_id [string] The Id of the identity …\n"],["delete_ip_access_control_list","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_ip_access_control_list","(ip_access_control_list_id)","<p>Deletes the IP Access Control List for the given Id.\n<p>@param ip_access_control_list_id [string] The Id …\n"],["delete_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_key","(key_id)","<p>Deletes the key for the given Id.\n<p>@param key_id [string] The Id of the key to delete. @return [FusionAuth::ClientResponse] …\n"],["delete_lambda","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_lambda","(lambda_id)","<p>Deletes the lambda for the given Id.\n<p>@param lambda_id [string] The Id of the lambda to delete. @return …\n"],["delete_message_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_message_template","(message_template_id)","<p>Deletes the message template for the given Id.\n<p>@param message_template_id [string] The Id of the message …\n"],["delete_messenger","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_messenger","(messenger_id)","<p>Deletes the messenger for the given Id.\n<p>@param messenger_id [string] The Id of the messenger to delete. …\n"],["delete_o_auth_scope","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_o_auth_scope","(application_id, scope_id)","<p>Hard deletes a custom OAuth scope. OAuth workflows that are still requesting the deleted OAuth scope …\n"],["delete_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_registration","(user_id, application_id)","<p>Deletes the user registration for the given user and application.\n<p>@param user_id [string] The Id of the …\n"],["delete_registration_with_request","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_registration_with_request","(user_id, application_id, request)","<p>Deletes the user registration for the given user and application along with the given JSON body that …\n"],["delete_tenant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_tenant","(tenant_id)","<p>Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, …\n"],["delete_tenant_async","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_tenant_async","(tenant_id)","<p>Deletes the tenant for the given Id asynchronously. This method is helpful if you do not want to wait …\n"],["delete_tenant_with_request","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_tenant_with_request","(tenant_id, request)","<p>Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all …\n"],["delete_theme","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_theme","(theme_id)","<p>Deletes the theme for the given Id.\n<p>@param theme_id [string] The Id of the theme to delete. @return [FusionAuth::ClientResponse] …\n"],["delete_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_user","(user_id)","<p>Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data …\n"],["delete_user_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_user_action","(user_action_id)","<p>Deletes the user action for the given Id. This permanently deletes the user action and also any history …\n"],["delete_user_action_reason","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_user_action_reason","(user_action_reason_id)","<p>Deletes the user action reason for the given Id.\n<p>@param user_action_reason_id [string] The Id of the user …\n"],["delete_user_link","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_user_link","(identity_provider_id, identity_provider_user_id, user_id)","<p>Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.\n<p>@param …\n"],["delete_user_with_request","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_user_with_request","(user_id, request)","<p>Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, …\n"],["delete_users","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_users","(request)","<p>Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order …\n"],["delete_users_by_query","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_users_by_query","(request)","<p>Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order …\n"],["delete_web_authn_credential","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_web_authn_credential","(id)","<p>Deletes the WebAuthn credential for the given Id.\n<p>@param id [string] The Id of the WebAuthn credential …\n"],["delete_webhook","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-delete_webhook","(webhook_id)","<p>Deletes the webhook for the given Id.\n<p>@param webhook_id [string] The Id of the webhook to delete. @return …\n"],["disable_two_factor","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-disable_two_factor","(user_id, method_id, code)","<p>Disable two-factor authentication for a user.\n<p>@param user_id [string] The Id of the User for which you&#39;re …\n"],["disable_two_factor_with_request","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-disable_two_factor_with_request","(user_id, request)","<p>Disable two-factor authentication for a user using a JSON body rather than URL parameters.\n<p>@param user_id …\n"],["enable_two_factor","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-enable_two_factor","(user_id, request)","<p>Enable two-factor authentication for a user.\n<p>@param user_id [string] The Id of the user to enable two-factor …\n"],["exchange_o_auth_code_for_access_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-exchange_o_auth_code_for_access_token","(code, client_id, client_secret, redirect_uri)","<p>Exchanges an OAuth authorization code for an access token. Makes a request to the Token endpoint to exchange …\n"],["exchange_o_auth_code_for_access_token_using_pkce","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-exchange_o_auth_code_for_access_token_using_pkce","(code, client_id, client_secret, redirect_uri, code_verifier)","<p>Exchanges an OAuth authorization code and code_verifier for an access token. Makes a request to the  …\n"],["exchange_refresh_token_for_access_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-exchange_refresh_token_for_access_token","(refresh_token, client_id, client_secret, scope, user_code)","<p>Exchange a Refresh Token for an Access Token. If you will be using the Refresh Token Grant, you will …\n"],["exchange_refresh_token_for_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-exchange_refresh_token_for_jwt","(request)","<p>Exchange a refresh token for a new JWT.\n<p>@param request [OpenStruct, Hash] The refresh request. @return …\n"],["exchange_user_credentials_for_access_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-exchange_user_credentials_for_access_token","(username, password, client_id, client_secret, scope, user_code)","<p>Exchange User Credentials for a Token. If you will be using the Resource Owner Password Credential Grant …\n"],["forgot_password","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-forgot_password","(request)","<p>Begins the forgot password sequence, which kicks off an email to the user so that they can reset their …\n"],["generate_email_verification_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-generate_email_verification_id","(email)","<p>Generate a new Email Verification Id to be used with the Verify Email API. This API will not attempt …\n"],["generate_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-generate_key","(key_id, request)","<p>Generate a new RSA or EC key pair or an HMAC secret.\n<p>@param key_id [string] (Optional) The Id for the …\n"],["generate_registration_verification_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-generate_registration_verification_id","(email, application_id)","<p>Generate a new Application Registration Verification Id to be used with the Verify Registration API. …\n"],["generate_two_factor_recovery_codes","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-generate_two_factor_recovery_codes","(user_id)","<p>Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any …\n"],["generate_two_factor_secret","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-generate_two_factor_secret","()","<p>Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response …\n"],["generate_two_factor_secret_using_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-generate_two_factor_secret_using_jwt","(encoded_jwt)","<p>Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response …\n"],["identity_provider_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-identity_provider_login","(request)","<p>Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other …\n"],["import_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-import_key","(key_id, request)","<p>Import an existing RSA or EC key pair or an HMAC secret.\n<p>@param key_id [string] (Optional) The Id for …\n"],["import_refresh_tokens","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-import_refresh_tokens","(request)","<p>Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh …\n"],["import_users","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-import_users","(request)","<p>Bulk imports users. This request performs minimal validation and runs batch inserts of users with the …\n"],["import_web_authn_credential","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-import_web_authn_credential","(request)","<p>Import a WebAuthn credential\n<p>@param request [OpenStruct, Hash] An object containing data necessary for …\n"],["introspect_access_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-introspect_access_token","(client_id, token)","<p>Inspect an access token issued as the result of the User based grant such as the Authorization Code  …\n"],["introspect_client_credentials_access_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-introspect_client_credentials_access_token","(token)","<p>Inspect an access token issued as the result of the Client Credentials Grant.\n<p>@param token [string] The …\n"],["issue_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-issue_jwt","(application_id, encoded_jwt, refresh_token)","<p>Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. …\n"],["login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-login","(request)","<p>Authenticates a user to FusionAuth. \n<p>This API optionally requires an API key. See <code>Application.loginConfiguration.requireAuthentication</code> …\n"],["login_ping","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-login_ping","(user_id, application_id, caller_ip_address)","<p>Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When …\n"],["login_ping_with_request","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-login_ping_with_request","(request)","<p>Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When …\n"],["logout","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-logout","(global, refresh_token)","<p>The Logout API is intended to be used to remove the refresh token and access token cookies if they exist …\n"],["logout_with_request","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-logout_with_request","(request)","<p>The Logout API is intended to be used to remove the refresh token and access token cookies if they exist …\n"],["lookup_identity_provider","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-lookup_identity_provider","(domain)","<p>Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed …\n"],["modify_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-modify_action","(action_id, request)","<p>Modifies a temporal user action by changing the expiration of the action and optionally adding a comment …\n"],["new","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-c-new","(api_key, base_url)",""],["passwordless_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-passwordless_login","(request)","<p>Complete a login request using a passwordless code\n<p>@param request [OpenStruct, Hash] The passwordless …\n"],["patch_api_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_api_key","(key_id, request)","<p>Updates an authentication API key by given id\n<p>@param key_id [string] The Id of the authentication key. …\n"],["patch_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_application","(application_id, request)","<p>Updates, via PATCH, the application with the given Id.\n<p>@param application_id [string] The Id of the application …\n"],["patch_application_role","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_application_role","(application_id, role_id, request)","<p>Updates, via PATCH, the application role with the given Id for the application.\n<p>@param application_id …\n"],["patch_connector","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_connector","(connector_id, request)","<p>Updates, via PATCH, the connector with the given Id.\n<p>@param connector_id [string] The Id of the connector …\n"],["patch_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_consent","(consent_id, request)","<p>Updates, via PATCH, the consent with the given Id.\n<p>@param consent_id [string] The Id of the consent to …\n"],["patch_email_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_email_template","(email_template_id, request)","<p>Updates, via PATCH, the email template with the given Id.\n<p>@param email_template_id [string] The Id of …\n"],["patch_entity_type","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_entity_type","(entity_type_id, request)","<p>Updates, via PATCH, the Entity Type with the given Id.\n<p>@param entity_type_id [string] The Id of the Entity …\n"],["patch_group","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_group","(group_id, request)","<p>Updates, via PATCH, the group with the given Id.\n<p>@param group_id [string] The Id of the group to update. …\n"],["patch_identity_provider","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_identity_provider","(identity_provider_id, request)","<p>Updates, via PATCH, the identity provider with the given Id.\n<p>@param identity_provider_id [string] The …\n"],["patch_integrations","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_integrations","(request)","<p>Updates, via PATCH, the available integrations.\n<p>@param request [OpenStruct, Hash] The request that contains …\n"],["patch_lambda","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_lambda","(lambda_id, request)","<p>Updates, via PATCH, the lambda with the given Id.\n<p>@param lambda_id [string] The Id of the lambda to update. …\n"],["patch_message_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_message_template","(message_template_id, request)","<p>Updates, via PATCH, the message template with the given Id.\n<p>@param message_template_id [string] The Id …\n"],["patch_messenger","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_messenger","(messenger_id, request)","<p>Updates, via PATCH, the messenger with the given Id.\n<p>@param messenger_id [string] The Id of the messenger …\n"],["patch_o_auth_scope","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_o_auth_scope","(application_id, scope_id, request)","<p>Updates, via PATCH, the custom OAuth scope with the given Id for the application.\n<p>@param application_id …\n"],["patch_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_registration","(user_id, request)","<p>Updates, via PATCH, the registration for the user with the given Id and the application defined in the …\n"],["patch_system_configuration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_system_configuration","(request)","<p>Updates, via PATCH, the system configuration.\n<p>@param request [OpenStruct, Hash] The request that contains …\n"],["patch_tenant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_tenant","(tenant_id, request)","<p>Updates, via PATCH, the tenant with the given Id.\n<p>@param tenant_id [string] The Id of the tenant to update. …\n"],["patch_theme","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_theme","(theme_id, request)","<p>Updates, via PATCH, the theme with the given Id.\n<p>@param theme_id [string] The Id of the theme to update. …\n"],["patch_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_user","(user_id, request)","<p>Updates, via PATCH, the user with the given Id.\n<p>@param user_id [string] The Id of the user to update. …\n"],["patch_user_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_user_action","(user_action_id, request)","<p>Updates, via PATCH, the user action with the given Id.\n<p>@param user_action_id [string] The Id of the user …\n"],["patch_user_action_reason","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_user_action_reason","(user_action_reason_id, request)","<p>Updates, via PATCH, the user action reason with the given Id.\n<p>@param user_action_reason_id [string] The …\n"],["patch_user_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-patch_user_consent","(user_consent_id, request)","<p>Updates, via PATCH, a single User consent by Id.\n<p>@param user_consent_id [string] The User Consent Id @param …\n"],["reactivate_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-reactivate_application","(application_id)","<p>Reactivates the application with the given Id.\n<p>@param application_id [string] The Id of the application …\n"],["reactivate_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-reactivate_user","(user_id)","<p>Reactivates the user with the given Id.\n<p>@param user_id [string] The Id of the user to reactivate. @return …\n"],["reactivate_user_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-reactivate_user_action","(user_action_id)","<p>Reactivates the user action with the given Id.\n<p>@param user_action_id [string] The Id of the user action …\n"],["reconcile_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-reconcile_jwt","(request)","<p>Reconcile a User to FusionAuth using JWT issued from another Identity Provider.\n<p>@param request [OpenStruct, …\n"],["refresh_entity_search_index","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-refresh_entity_search_index","()","<p>Request a refresh of the Entity search index. This API is not generally necessary and the search index …\n"],["refresh_user_search_index","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-refresh_user_search_index","()","<p>Request a refresh of the User search index. This API is not generally necessary and the search index …\n"],["regenerate_reactor_keys","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-regenerate_reactor_keys","()","<p>Regenerates any keys that are used by the FusionAuth Reactor.\n<p>@return [FusionAuth::ClientResponse] The …\n"],["register","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-register","(user_id, request)","<p>Registers a user for an application. If you provide the User and the UserRegistration object on this …\n"],["reindex","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-reindex","(request)","<p>Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful …\n"],["remove_user_from_family","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-remove_user_from_family","(family_id, user_id)","<p>Removes a user from the family with the given id.\n<p>@param family_id [string] The Id of the family to remove …\n"],["resend_email_verification","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-resend_email_verification","(email)","<p>Re-sends the verification email to the user.\n<p>@param email [string] The email address of the user that …\n"],["resend_email_verification_with_application_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-resend_email_verification_with_application_template","(application_id, email)","<p>Re-sends the verification email to the user. If the Application has configured a specific email template …\n"],["resend_registration_verification","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-resend_registration_verification","(email, application_id)","<p>Re-sends the application registration verification email to the user.\n<p>@param email [string] The email …\n"],["retrieve_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_action","(action_id)","<p>Retrieves a single action log (the log of a user action that was taken on a user previously) for the …\n"],["retrieve_actions","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_actions","(user_id)","<p>Retrieves all the actions for the user with the given Id. This will return all time based actions that …\n"],["retrieve_actions_preventing_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_actions_preventing_login","(user_id)","<p>Retrieves all the actions for the user with the given Id that are currently preventing the User from …\n"],["retrieve_active_actions","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_active_actions","(user_id)","<p>Retrieves all the actions for the user with the given Id that are currently active. An active action …\n"],["retrieve_api_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_api_key","(key_id)","<p>Retrieves an authentication API key for the given id\n<p>@param key_id [string] The Id of the API key to retrieve. …\n"],["retrieve_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_application","(application_id)","<p>Retrieves the application for the given Id or all the applications if the Id is null.\n<p>@param application_id …\n"],["retrieve_applications","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_applications","()","<p>Retrieves all the applications.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_audit_log","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_audit_log","(audit_log_id)","<p>Retrieves a single audit log for the given Id.\n<p>@param audit_log_id [Numeric] The Id of the audit log to …\n"],["retrieve_connector","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_connector","(connector_id)","<p>Retrieves the connector with the given Id.\n<p>@param connector_id [string] The Id of the connector. @return …\n"],["retrieve_connectors","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_connectors","()","<p>Retrieves all the connectors.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_consent","(consent_id)","<p>Retrieves the Consent for the given Id.\n<p>@param consent_id [string] The Id of the consent. @return [FusionAuth::ClientResponse] …\n"],["retrieve_consents","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_consents","()","<p>Retrieves all the consent.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_daily_active_report","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_daily_active_report","(application_id, start, _end)","<p>Retrieves the daily active user report between the two instants. If you specify an application id, it …\n"],["retrieve_email_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_email_template","(email_template_id)","<p>Retrieves the email template for the given Id. If you don&#39;t specify the id, this will return all …\n"],["retrieve_email_template_preview","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_email_template_preview","(request)","<p>Creates a preview of the email template provided in the request. This allows you to preview an email …\n"],["retrieve_email_templates","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_email_templates","()","<p>Retrieves all the email templates.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_entity","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_entity","(entity_id)","<p>Retrieves the Entity for the given Id.\n<p>@param entity_id [string] The Id of the Entity. @return [FusionAuth::ClientResponse] …\n"],["retrieve_entity_grant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_entity_grant","(entity_id, recipient_entity_id, user_id)","<p>Retrieves an Entity Grant for the given Entity and User/Entity.\n<p>@param entity_id [string] The Id of the …\n"],["retrieve_entity_type","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_entity_type","(entity_type_id)","<p>Retrieves the Entity Type for the given Id.\n<p>@param entity_type_id [string] The Id of the Entity Type. …\n"],["retrieve_entity_types","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_entity_types","()","<p>Retrieves all the Entity Types.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_event_log","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_event_log","(event_log_id)","<p>Retrieves a single event log for the given Id.\n<p>@param event_log_id [Numeric] The Id of the event log to …\n"],["retrieve_families","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_families","(user_id)","<p>Retrieves all the families that a user belongs to.\n<p>@param user_id [string] The User&#39;s id @return [FusionAuth::ClientResponse] …\n"],["retrieve_family_members_by_family_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_family_members_by_family_id","(family_id)","<p>Retrieves all the members of a family by the unique Family Id.\n<p>@param family_id [string] The unique Id …\n"],["retrieve_form","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_form","(form_id)","<p>Retrieves the form with the given Id.\n<p>@param form_id [string] The Id of the form. @return [FusionAuth::ClientResponse] …\n"],["retrieve_form_field","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_form_field","(field_id)","<p>Retrieves the form field with the given Id.\n<p>@param field_id [string] The Id of the form field. @return …\n"],["retrieve_form_fields","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_form_fields","()","<p>Retrieves all the forms fields\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_forms","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_forms","()","<p>Retrieves all the forms.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_group","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_group","(group_id)","<p>Retrieves the group for the given Id.\n<p>@param group_id [string] The Id of the group. @return [FusionAuth::ClientResponse] …\n"],["retrieve_groups","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_groups","()","<p>Retrieves all the groups.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_identity_provider","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_identity_provider","(identity_provider_id)","<p>Retrieves the identity provider for the given Id or all the identity providers if the Id is null.\n<p>@param …\n"],["retrieve_identity_provider_by_type","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_identity_provider_by_type","(type)","<p>Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter …\n"],["retrieve_identity_providers","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_identity_providers","()","<p>Retrieves all the identity providers.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object. …\n"],["retrieve_inactive_actions","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_inactive_actions","(user_id)","<p>Retrieves all the actions for the user with the given Id that are currently inactive. An inactive action …\n"],["retrieve_inactive_applications","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_inactive_applications","()","<p>Retrieves all the applications that are currently inactive.\n<p>@return [FusionAuth::ClientResponse] The  …\n"],["retrieve_inactive_user_actions","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_inactive_user_actions","()","<p>Retrieves all the user actions that are currently inactive.\n<p>@return [FusionAuth::ClientResponse] The  …\n"],["retrieve_integration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_integration","()","<p>Retrieves the available integrations.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object. …\n"],["retrieve_ip_access_control_list","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_ip_access_control_list","(ip_access_control_list_id)","<p>Retrieves the IP Access Control List with the given Id.\n<p>@param ip_access_control_list_id [string] The …\n"],["retrieve_json_web_key_set","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_json_web_key_set","()","<p>Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format. …\n"],["retrieve_jwt_public_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_jwt_public_key","(key_id)","<p>Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).\n<p>@param key_id …\n"],["retrieve_jwt_public_key_by_application_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_jwt_public_key_by_application_id","(application_id)","<p>Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by …\n"],["retrieve_jwt_public_keys","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_jwt_public_keys","()","<p>Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).\n<p>@return [FusionAuth::ClientResponse] …\n"],["retrieve_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_key","(key_id)","<p>Retrieves the key for the given Id.\n<p>@param key_id [string] The Id of the key. @return [FusionAuth::ClientResponse] …\n"],["retrieve_keys","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_keys","()","<p>Retrieves all the keys.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_lambda","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_lambda","(lambda_id)","<p>Retrieves the lambda for the given Id.\n<p>@param lambda_id [string] The Id of the lambda. @return [FusionAuth::ClientResponse] …\n"],["retrieve_lambdas","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_lambdas","()","<p>Retrieves all the lambdas.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_lambdas_by_type","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_lambdas_by_type","(type)","<p>Retrieves all the lambdas for the provided type.\n<p>@param type [OpenStruct, Hash] The type of the lambda …\n"],["retrieve_login_report","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_login_report","(application_id, start, _end)","<p>Retrieves the login report between the two instants. If you specify an application id, it will only return …\n"],["retrieve_message_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_message_template","(message_template_id)","<p>Retrieves the message template for the given Id. If you don&#39;t specify the id, this will return all …\n"],["retrieve_message_template_preview","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_message_template_preview","(request)","<p>Creates a preview of the message template provided in the request, normalized to a given locale.\n<p>@param …\n"],["retrieve_message_templates","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_message_templates","()","<p>Retrieves all the message templates.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_messenger","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_messenger","(messenger_id)","<p>Retrieves the messenger with the given Id.\n<p>@param messenger_id [string] The Id of the messenger. @return …\n"],["retrieve_messengers","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_messengers","()","<p>Retrieves all the messengers.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_monthly_active_report","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_monthly_active_report","(application_id, start, _end)","<p>Retrieves the monthly active user report between the two instants. If you specify an application id, …\n"],["retrieve_o_auth_scope","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_o_auth_scope","(application_id, scope_id)","<p>Retrieves a custom OAuth scope.\n<p>@param application_id [string] The Id of the application that the OAuth …\n"],["retrieve_oauth_configuration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_oauth_configuration","(application_id)","<p>Retrieves the Oauth2 configuration for the application for the given Application Id.\n<p>@param application_id …\n"],["retrieve_open_id_configuration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_open_id_configuration","()","<p>Returns the well known OpenID Configuration JSON document\n<p>@return [FusionAuth::ClientResponse] The ClientResponse …\n"],["retrieve_password_validation_rules","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_password_validation_rules","()","<p>Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be …\n"],["retrieve_password_validation_rules_with_tenant_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_password_validation_rules_with_tenant_id","(tenant_id)","<p>Retrieves the password validation rules for a specific tenant.\n<p>This API does not require an API key.\n<p>@param …\n"],["retrieve_pending_children","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_pending_children","(parent_email)","<p>Retrieves all the children for the given parent email address.\n<p>@param parent_email [string] The email …\n"],["retrieve_pending_link","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_pending_link","(pending_link_id, user_id)","<p>Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data …\n"],["retrieve_reactor_metrics","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_reactor_metrics","()","<p>Retrieves the FusionAuth Reactor metrics.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object. …\n"],["retrieve_reactor_status","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_reactor_status","()","<p>Retrieves the FusionAuth Reactor status.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object. …\n"],["retrieve_recent_logins","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_recent_logins","(offset, limit)","<p>Retrieves the last number of login records.\n<p>@param offset [Numeric] The initial record. e.g. 0 is the …\n"],["retrieve_refresh_token_by_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_refresh_token_by_id","(token_id)","<p>Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the …\n"],["retrieve_refresh_tokens","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_refresh_tokens","(user_id)","<p>Retrieves the refresh tokens that belong to the user with the given Id.\n<p>@param user_id [string] The Id …\n"],["retrieve_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_registration","(user_id, application_id)","<p>Retrieves the user registration for the user with the given Id and the given application id.\n<p>@param user_id …\n"],["retrieve_registration_report","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_registration_report","(application_id, start, _end)","<p>Retrieves the registration report between the two instants. If you specify an application id, it will …\n"],["retrieve_reindex_status","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_reindex_status","()","<p>Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, …\n"],["retrieve_system_configuration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_system_configuration","()","<p>Retrieves the system configuration.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_tenant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_tenant","(tenant_id)","<p>Retrieves the tenant for the given Id.\n<p>@param tenant_id [string] The Id of the tenant. @return [FusionAuth::ClientResponse] …\n"],["retrieve_tenants","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_tenants","()","<p>Retrieves all the tenants.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_theme","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_theme","(theme_id)","<p>Retrieves the theme for the given Id.\n<p>@param theme_id [string] The Id of the theme. @return [FusionAuth::ClientResponse] …\n"],["retrieve_themes","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_themes","()","<p>Retrieves all the themes.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_total_report","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_total_report","()","<p>Retrieves the totals report. This contains all the total counts for each application and the global registration …\n"],["retrieve_two_factor_recovery_codes","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_two_factor_recovery_codes","(user_id)","<p>Retrieve two-factor recovery codes for a user.\n<p>@param user_id [string] The Id of the user to retrieve …\n"],["retrieve_two_factor_status","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_two_factor_status","(user_id, application_id, two_factor_trust_id)","<p>Retrieve a user&#39;s two-factor status.\n<p>This can be used to see if a user will need to complete a two-factor …\n"],["retrieve_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user","(user_id)","<p>Retrieves the user for the given Id.\n<p>@param user_id [string] The Id of the user. @return [FusionAuth::ClientResponse] …\n"],["retrieve_user_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_action","(user_action_id)","<p>Retrieves the user action for the given Id. If you pass in null for the id, this will return all the …\n"],["retrieve_user_action_reason","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_action_reason","(user_action_reason_id)","<p>Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all …\n"],["retrieve_user_action_reasons","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_action_reasons","()","<p>Retrieves all the user action reasons.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object. …\n"],["retrieve_user_actions","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_actions","()","<p>Retrieves all the user actions.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["retrieve_user_by_change_password_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_by_change_password_id","(change_password_id)","<p>Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after …\n"],["retrieve_user_by_email","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_by_email","(email)","<p>Retrieves the user for the given email.\n<p>@param email [string] The email of the user. @return [FusionAuth::ClientResponse] …\n"],["retrieve_user_by_login_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_by_login_id","(login_id)","<p>Retrieves the user for the loginId. The loginId can be either the username or the email.\n<p>@param login_id …\n"],["retrieve_user_by_username","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_by_username","(username)","<p>Retrieves the user for the given username.\n<p>@param username [string] The username of the user. @return …\n"],["retrieve_user_by_verification_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_by_verification_id","(verification_id)","<p>Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the …\n"],["retrieve_user_code","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_code","(client_id, client_secret, user_code)","<p>Retrieve a user_code that is part of an in-progress Device Authorization Grant.\n<p>This API is useful if …\n"],["retrieve_user_code_using_api_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_code_using_api_key","(user_code)","<p>Retrieve a user_code that is part of an in-progress Device Authorization Grant.\n<p>This API is useful if …\n"],["retrieve_user_comments","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_comments","(user_id)","<p>Retrieves all the comments for the user with the given Id.\n<p>@param user_id [string] The Id of the user. …\n"],["retrieve_user_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_consent","(user_consent_id)","<p>Retrieve a single User consent by Id.\n<p>@param user_consent_id [string] The User consent Id @return [FusionAuth::ClientResponse] …\n"],["retrieve_user_consents","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_consents","(user_id)","<p>Retrieves all the consents for a User.\n<p>@param user_id [string] The User&#39;s Id @return [FusionAuth::ClientResponse] …\n"],["retrieve_user_info_from_access_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_info_from_access_token","(encoded_jwt)","<p>Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.\n<p>@param …\n"],["retrieve_user_link","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_link","(identity_provider_id, identity_provider_user_id, user_id)","<p>Retrieve a single Identity Provider user (link).\n<p>@param identity_provider_id [string] The unique Id of …\n"],["retrieve_user_links_by_user_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_links_by_user_id","(identity_provider_id, user_id)","<p>Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to …\n"],["retrieve_user_login_report","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_login_report","(application_id, user_id, start, _end)","<p>Retrieves the login report between the two instants for a particular user by Id. If you specify an application …\n"],["retrieve_user_login_report_by_login_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_login_report_by_login_id","(application_id, login_id, start, _end)","<p>Retrieves the login report between the two instants for a particular user by login Id. If you specify …\n"],["retrieve_user_recent_logins","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_recent_logins","(user_id, offset, limit)","<p>Retrieves the last number of login records for a user.\n<p>@param user_id [string] The Id of the user. @param …\n"],["retrieve_user_using_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_user_using_jwt","(encoded_jwt)","<p>Retrieves the user for the given Id. This method does not use an API key, instead it uses a JSON Web …\n"],["retrieve_version","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_version","()","<p>Retrieves the FusionAuth version string.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object. …\n"],["retrieve_web_authn_credential","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_web_authn_credential","(id)","<p>Retrieves the WebAuthn credential for the given Id.\n<p>@param id [string] The Id of the WebAuthn credential. …\n"],["retrieve_web_authn_credentials_for_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_web_authn_credentials_for_user","(user_id)","<p>Retrieves all WebAuthn credentials for the given user.\n<p>@param user_id [string] The user&#39;s ID. @return …\n"],["retrieve_webhook","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_webhook","(webhook_id)","<p>Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks. …\n"],["retrieve_webhooks","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-retrieve_webhooks","()","<p>Retrieves all the webhooks.\n<p>@return [FusionAuth::ClientResponse] The ClientResponse object.\n"],["revoke_refresh_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_refresh_token","(token, user_id, application_id)","<p>Revokes refresh tokens.\n<p>Usage examples:\n\n<pre>- Delete a single refresh token, pass in only the token.\n    revokeRefreshToken(token) ...</pre>\n"],["revoke_refresh_token_by_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_refresh_token_by_id","(token_id)","<p>Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used …\n"],["revoke_refresh_token_by_token","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_refresh_token_by_token","(token)","<p>Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, …\n"],["revoke_refresh_tokens_by_application_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_refresh_tokens_by_application_id","(application_id)","<p>Revoke all refresh tokens that belong to an application by applicationId.\n<p>@param application_id [string] …\n"],["revoke_refresh_tokens_by_user_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_refresh_tokens_by_user_id","(user_id)","<p>Revoke all refresh tokens that belong to a user by user Id.\n<p>@param user_id [string] The unique Id of the …\n"],["revoke_refresh_tokens_by_user_id_for_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_refresh_tokens_by_user_id_for_application","(user_id, application_id)","<p>Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId. …\n"],["revoke_refresh_tokens_with_request","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_refresh_tokens_with_request","(request)","<p>Revokes refresh tokens using the information in the JSON body. The handling for this method is the same …\n"],["revoke_user_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-revoke_user_consent","(user_consent_id)","<p>Revokes a single User consent by Id.\n<p>@param user_consent_id [string] The User Consent Id @return [FusionAuth::ClientResponse] …\n"],["search_applications","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_applications","(request)","<p>Searches applications with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The …\n"],["search_audit_logs","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_audit_logs","(request)","<p>Searches the audit logs with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] …\n"],["search_consents","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_consents","(request)","<p>Searches consents with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["search_email_templates","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_email_templates","(request)","<p>Searches email templates with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] …\n"],["search_entities","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_entities","(request)","<p>Searches entities with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["search_entities_by_ids","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_entities_by_ids","(ids)","<p>Retrieves the entities for the given ids. If any Id is invalid, it is ignored.\n<p>@param ids [Array] The …\n"],["search_entity_grants","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_entity_grants","(request)","<p>Searches Entity Grants with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash]  …\n"],["search_entity_types","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_entity_types","(request)","<p>Searches the entity types with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] …\n"],["search_event_logs","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_event_logs","(request)","<p>Searches the event logs with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] …\n"],["search_group_members","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_group_members","(request)","<p>Searches group members with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash]  …\n"],["search_groups","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_groups","(request)","<p>Searches groups with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["search_identity_providers","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_identity_providers","(request)","<p>Searches identity providers with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] …\n"],["search_ip_access_control_lists","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_ip_access_control_lists","(request)","<p>Searches the IP Access Control Lists with the specified criteria and pagination.\n<p>@param request [OpenStruct, …\n"],["search_keys","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_keys","(request)","<p>Searches keys with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["search_lambdas","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_lambdas","(request)","<p>Searches lambdas with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["search_login_records","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_login_records","(request)","<p>Searches the login records with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] …\n"],["search_tenants","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_tenants","(request)","<p>Searches tenants with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["search_themes","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_themes","(request)","<p>Searches themes with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["search_user_comments","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_user_comments","(request)","<p>Searches user comments with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash]  …\n"],["search_users","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_users","(ids)","<p>Retrieves the users for the given ids. If any Id is invalid, it is ignored.\n<p>@param ids [Array] The user …\n"],["search_users_by_ids","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_users_by_ids","(ids)","<p>Retrieves the users for the given ids. If any Id is invalid, it is ignored.\n<p>@param ids [Array] The user …\n"],["search_users_by_query","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_users_by_query","(request)","<p>Retrieves the users for the given search criteria and pagination.\n<p>@param request [OpenStruct, Hash] The …\n"],["search_users_by_query_string","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_users_by_query_string","(request)","<p>Retrieves the users for the given search criteria and pagination.\n<p>@param request [OpenStruct, Hash] The …\n"],["search_webhooks","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-search_webhooks","(request)","<p>Searches webhooks with the specified criteria and pagination.\n<p>@param request [OpenStruct, Hash] The search …\n"],["send_email","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-send_email","(email_template_id, request)","<p>Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value …\n"],["send_family_request_email","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-send_family_request_email","(request)","<p>Sends out an email to a parent that they need to register and create a family or need to log in and add …\n"],["send_passwordless_code","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-send_passwordless_code","(request)","<p>Send a passwordless authentication code in an email to complete login.\n<p>@param request [OpenStruct, Hash] …\n"],["send_two_factor_code","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-send_two_factor_code","(request)","<p>Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. …\n"],["send_two_factor_code_for_enable_disable","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-send_two_factor_code_for_enable_disable","(request)","<p>Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. …\n"],["send_two_factor_code_for_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-send_two_factor_code_for_login","(two_factor_id)","<p>Send a Two Factor authentication code to allow the completion of Two Factor authentication.\n<p>@param two_factor_id …\n"],["send_two_factor_code_for_login_using_method","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-send_two_factor_code_for_login_using_method","(two_factor_id, request)","<p>Send a Two Factor authentication code to allow the completion of Two Factor authentication.\n<p>@param two_factor_id …\n"],["set_tenant_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-set_tenant_id","(tenant_id)",""],["start_identity_provider_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-start_identity_provider_login","(request)","<p>Begins a login request for a 3rd party login that requires user interaction such as HYPR.\n<p>@param request …\n"],["start_passwordless_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-start_passwordless_login","(request)","<p>Start a passwordless login request by generating a passwordless code. This code can be sent to the User …\n"],["start_two_factor_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-start_two_factor_login","(request)","<p>Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to …\n"],["start_web_authn_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-start_web_authn_login","(request)","<p>Start a WebAuthn authentication ceremony by generating a new challenge for the user\n<p>@param request [OpenStruct, …\n"],["start_web_authn_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-start_web_authn_registration","(request)","<p>Start a WebAuthn registration ceremony by generating a new challenge for the user\n<p>@param request [OpenStruct, …\n"],["two_factor_login","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-two_factor_login","(request)","<p>Complete login using a 2FA challenge\n<p>@param request [OpenStruct, Hash] The login request that contains …\n"],["update_api_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_api_key","(api_key_id, request)","<p>Updates an API key by given id\n<p>@param api_key_id [string] The Id of the API key to update. @param request …\n"],["update_application","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_application","(application_id, request)","<p>Updates the application with the given Id.\n<p>@param application_id [string] The Id of the application to …\n"],["update_application_role","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_application_role","(application_id, role_id, request)","<p>Updates the application role with the given Id for the application.\n<p>@param application_id [string] The …\n"],["update_connector","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_connector","(connector_id, request)","<p>Updates the connector with the given Id.\n<p>@param connector_id [string] The Id of the connector to update. …\n"],["update_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_consent","(consent_id, request)","<p>Updates the consent with the given Id.\n<p>@param consent_id [string] The Id of the consent to update. @param …\n"],["update_email_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_email_template","(email_template_id, request)","<p>Updates the email template with the given Id.\n<p>@param email_template_id [string] The Id of the email template …\n"],["update_entity","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_entity","(entity_id, request)","<p>Updates the Entity with the given Id.\n<p>@param entity_id [string] The Id of the Entity to update. @param …\n"],["update_entity_type","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_entity_type","(entity_type_id, request)","<p>Updates the Entity Type with the given Id.\n<p>@param entity_type_id [string] The Id of the Entity Type to …\n"],["update_entity_type_permission","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_entity_type_permission","(entity_type_id, permission_id, request)","<p>Updates the permission with the given Id for the entity type.\n<p>@param entity_type_id [string] The Id of …\n"],["update_form","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_form","(form_id, request)","<p>Updates the form with the given Id.\n<p>@param form_id [string] The Id of the form to update. @param request …\n"],["update_form_field","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_form_field","(field_id, request)","<p>Updates the form field with the given Id.\n<p>@param field_id [string] The Id of the form field to update. …\n"],["update_group","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_group","(group_id, request)","<p>Updates the group with the given Id.\n<p>@param group_id [string] The Id of the group to update. @param request …\n"],["update_group_members","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_group_members","(request)","<p>Creates a member in a group.\n<p>@param request [OpenStruct, Hash] The request object that contains all the …\n"],["update_identity_provider","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_identity_provider","(identity_provider_id, request)","<p>Updates the identity provider with the given Id.\n<p>@param identity_provider_id [string] The Id of the identity …\n"],["update_integrations","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_integrations","(request)","<p>Updates the available integrations.\n<p>@param request [OpenStruct, Hash] The request that contains all the …\n"],["update_ip_access_control_list","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_ip_access_control_list","(access_control_list_id, request)","<p>Updates the IP Access Control List with the given Id.\n<p>@param access_control_list_id [string] The Id of …\n"],["update_key","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_key","(key_id, request)","<p>Updates the key with the given Id.\n<p>@param key_id [string] The Id of the key to update. @param request …\n"],["update_lambda","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_lambda","(lambda_id, request)","<p>Updates the lambda with the given Id.\n<p>@param lambda_id [string] The Id of the lambda to update. @param …\n"],["update_message_template","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_message_template","(message_template_id, request)","<p>Updates the message template with the given Id.\n<p>@param message_template_id [string] The Id of the message …\n"],["update_messenger","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_messenger","(messenger_id, request)","<p>Updates the messenger with the given Id.\n<p>@param messenger_id [string] The Id of the messenger to update. …\n"],["update_o_auth_scope","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_o_auth_scope","(application_id, scope_id, request)","<p>Updates the OAuth scope with the given Id for the application.\n<p>@param application_id [string] The Id of …\n"],["update_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_registration","(user_id, request)","<p>Updates the registration for the user with the given Id and the application defined in the request.\n<p>@param …\n"],["update_system_configuration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_system_configuration","(request)","<p>Updates the system configuration.\n<p>@param request [OpenStruct, Hash] The request that contains all the …\n"],["update_tenant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_tenant","(tenant_id, request)","<p>Updates the tenant with the given Id.\n<p>@param tenant_id [string] The Id of the tenant to update. @param …\n"],["update_theme","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_theme","(theme_id, request)","<p>Updates the theme with the given Id.\n<p>@param theme_id [string] The Id of the theme to update. @param request …\n"],["update_user","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_user","(user_id, request)","<p>Updates the user with the given Id.\n<p>@param user_id [string] The Id of the user to update. @param request …\n"],["update_user_action","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_user_action","(user_action_id, request)","<p>Updates the user action with the given Id.\n<p>@param user_action_id [string] The Id of the user action to …\n"],["update_user_action_reason","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_user_action_reason","(user_action_reason_id, request)","<p>Updates the user action reason with the given Id.\n<p>@param user_action_reason_id [string] The Id of the …\n"],["update_user_consent","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_user_consent","(user_consent_id, request)","<p>Updates a single User consent by Id.\n<p>@param user_consent_id [string] The User Consent Id @param request …\n"],["update_webhook","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-update_webhook","(webhook_id, request)","<p>Updates the webhook with the given Id.\n<p>@param webhook_id [string] The Id of the webhook to update. @param …\n"],["upsert_entity_grant","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-upsert_entity_grant","(entity_id, request)","<p>Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.\n<p>@param …\n"],["validate_device","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-validate_device","(user_code, client_id)","<p>Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant …\n"],["validate_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-validate_jwt","(encoded_jwt)","<p>Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is …\n"],["vend_jwt","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-vend_jwt","(request)","<p>It&#39;s a JWT vending machine!\n<p>Issue a new access token (JWT) with the provided claims in the request. …\n"],["verify_email","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-verify_email","(verification_id)","<p>Confirms a email verification. The Id given is usually from an email sent to the user.\n<p>@param verification_id …\n"],["verify_email_address","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-verify_email_address","(request)","<p>Confirms a user&#39;s email address. \n<p>The request body will contain the verificationId. You may also be …\n"],["verify_email_address_by_user_id","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-verify_email_address_by_user_id","(request)","<p>Administratively verify a user&#39;s email address. Use this method to bypass email verification for …\n"],["verify_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-verify_registration","(verification_id)","<p>Confirms an application registration. The Id given is usually from an email sent to the user.\n<p>@param  …\n"],["verify_user_registration","FusionAuth::FusionAuthClient","FusionAuth/FusionAuthClient.html#method-i-verify_user_registration","(request)","<p>Confirms a user&#39;s registration. \n<p>The request body will contain the verificationId. You may also be …\n"]]}}

data/doc/js/searcher.js

@@ -0,0 +1,229 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return queries.map(function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return queries.map(function(query) {
+      return query.split('').map(function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    result.badge = info[6];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    this.handlers.forEach(function(fn) {
+      fn.call(this, results, isLast)
+    });
+  }
+}
+