Views

index

View that renders the index for management users. To access this view, the user needs to be logged in and belong to the management. group.

  • URL:

  • GET: Provides the data to the frontend:

    • component: Index

    • props: No date

users_list

View to provide the frontend with the list of users registered in the application. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/users

  • GET: Provides the data to the frontend; these data are:

    • component: Users

    • props:

    props = {
    "users": # List of users,
    "count": # Number of registered users,
    "paginateBy": # Number of users displayed per page,
    "pages": # Number of pages needed to show the total number of users,
    "currentPage": # Current page,
    "search": # Search criteria, used to filter the list,
}

user_detail

View to provide the frontend with the details of a specific user. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/

  • GET: Receives the user_id as a parameter to identify the CustomUser model. It provides the data to the frontend, these are the data: -component: UserDetail

    • props:

    props = {
    "user": # Detail of the user of the CustomUser model,
    "maxSizeFile": # Maximum size allowed for uploading files,
    "availableLanguages": # Dictionary with the available languages,
    "availableCountries": # Dictionary with the countries enabled,
    "availableGroups": # Dictionary with the groups enabled,
    "availableDateFormats": # Dictionary with date formats,
    "tfaActive": # Boolean that indicates if the user has the TFA active or not,
}

user_change_status

View that allows the manager to change the active/deactivated status of a user; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change-status

  • GET: Changes the status of the is_active field of the CustomUser model to its opposite value to the one it currently has.

user_deactivate_tfa

View that allows the manager to switch off a user’s two-factor authentication; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/deactivate-tfa

  • GET: Eliminates the user’s registration in the Otp model of the two_factor_auth app.

user_reset_password

View that allows the manager to send an email to change a user’s password; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/deactivate-tfa

  • GET: Sends an email to the user to start the password change process.

user_change_names

View that allows the manager to change the first and last name of a user; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change/names

  • POST: It is received as firstName and lastName parameters and changes the values ​​of the first_name and last_name fields, respectively, of the user in the CustomUser model.

user_change_photo

View that allows the manager to change a user’s profile photo; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change/photo

  • POST: A File type request with the file is received as parameters. It is validated that it meets the requirements (file type and size). It is stored in the media path and the location is recorded in the photo field of the UserProfile model associated with the user.

user_remove_photo

View that allows the manager to remove a user’s profile photo; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/remove/photo

  • GET: Eliminates the location that refers to the location of the photo in the photo field of the UserProfile model associated with a user.

user_change_job_title

View that allows the manager to change the profession of a user; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change/job

  • POST: It is received as jobTitle parameters and changes the value of the user job_title field in the UserProfile model.

change_language

View that allows the manager to change the preferred language of a user; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change/language

  • POST: It is received as a language parameter and changes the value of the language field of the UserProfile model associated with a user.

change_country

View that allows the manager to change the preferred country of a user; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change/country

  • POST: It is received as a country parameter and changes the value of the country field of the UserProfile model associated with a user.

change_date_format

View that allows the manager to change a user’s preferred date format; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change/date-format

  • POST: It is received as a dateFormat parameter and changes the value of the date_format field of the UserProfile model associated with a user.

change_user_groups

View that allows the manager to change the user group to which a user belongs; then it is redirected to the user_detail view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/user/<user_id>/change/group

  • POST: It is received as a group parameter and adds the user to the Group model within the selected user group.

settings

View that renders the OTP configuration template. If the management user does not have two-factor authentication configured, they are redirected to the setup_otp view to set it up. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/2fa

  • GET: Provides the frontend with the following data: -component: OtpSettings

    • props:

        props = {
        "routeRemoveOtp": # Route to remove the user's OTP settings
    }

setup_otp

View that provides the necessary data for the user to configure their two-factor authentication through the Otp method. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/2fa/setup/otp

  • GET: Provides the frontend with the data to render: -component: OtpSetup

    • props:

    props = {
    "step": # The configuration consists of two steps. Here it is indicated in which step it is,
    "routeSetupOtp": # Route to set the Otp,
    "routeToSettings": # Route to go to the Otp settings,
    "secret": # String secret of the Otp configuration required for activation
    "qr": # QR code image in base64 format
    "words": # Otp recovery words
}

  • POST: Validates that the otpSettings and otp fields are correct to activate the OTP method.

remove_otp

View to remove from two-factor authentication user management. Then it redirects to the settings view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/2fa/remove/otp

  • GET: Eliminates the registration in the user’s Otp model.

create_user

View to provide the frontend with the necessary data to create a new user. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/users/create

  • GET: Provides the frontend with the following data: -component: UserCreate

    • props:

    props = {
    "availableGroups": # Dictionary with the groups enabled,
}

  • POST: Validates the fields email, password, firstName, lastName and group to create a new user. If they are valid, the user is created and redirected to the user_list view; otherwise the error is added to the general inertia props.

notifications_list

View to list existing application notifications. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/notifications

  • GET: Provides the frontend with the following data: -component:Notifications

    • props:

    props = {
    "notifications": # List of notifications,
    "count": # Number of registered notifications,
    "paginateBy": # Number of notifications per page,
    "pages": # Number of pages to display all records,
    "currentPage": # Current page,
    "availableLanguages": # Dictionary of available languages,
}

notification_create

View to provide the frontend with the necessary data to create a notification. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/notifications/create

  • GET: Provides the frontend with the following data: -component:NotificationCreate

    • props:

    props = {
    "availableTypeNotifications": # Dictionary with the type of notifications,
    "availableLanguages": # Dictionary with the available languages,
}

  • POST: Validates the fields to create a new notification in the Notifications model of the core app.

notification_edit

View to provide the frontend with the necessary data to edit a notification. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/notifications/edit/<notification_id>/

  • GET: Provides the frontend with the following data: -component:NotificationEdit

    • props:

    props = {
    "notification": # Notification Details,
    "availableTypeNotifications": # Dictionary with the type of notifications,
    "availableLanguages": # Dictionary with the available languages,
}

  • POST: Validates the fields to edit the notification in the Notifications model of the core app.

notification_delete

View to delete a notification from the Notifications model; then redirects to the notifications_list. view To access this view the user must be logged in and belong to the management. group

  • URL: /manage/notifications/delete/<notification_id>/

  • GET: Delete the notification from the Notifications model.

global_settings_general

Renders the general global settings template. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/general

  • GET: Provides the frontend with the following data: -component:SystemSettingsGeneral -props: No date

system_change_app_name

View that allows the manager to change the app name; then it is redirected to the global_settings_general view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/system/change/app-name

  • POST: appName is received as a parameter and changes the name_app field in the GlobalSettings model

global_settings_security

Renders the general application security configuration template. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/security

  • GET: Provides the frontend with the following data: -component:SystemSettingsSecurity

    • props: shell props = { "auditInstalled": # Indicates if the audit module is installed }

system_change_session_expire_time

View that allows the manager to set a session expiration time; then it is redirected to the global_settings_security view. If this field has no value, the system takes the data from the settings variable SESSION_EXPIRE_TIME. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/security/change/session-expire-time

  • POST: sessionExpireTime is received as a parameter and changes the session_expire_time field in the GlobalSettings model.

system_active_audit

View that allows the manager to activate/deactivate the audit module if it is installed in the application; then it is redirected to the global_settings_security view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/security/active/audit

  • GET: Change the value to its opposite in the active_audit field of the GlobalSettings model.

system_active_ip_auth

View that allows the manager to activate/deactivate the new device and ip authorization module; then it is redirected to the global_settings_security view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/security/active/ip_auth

  • GET: Change the value to its opposite in the active_ip_authorization field of the GlobalSettings model.

global_settings_audit

Renders the application’s audit settings template. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/audit

  • GET: Provides the frontend with the following data: -component:SystemSettingsAudit -props: No date

device_list

View to list the authorized devices and ip of the management user. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/devices

  • GET: Provides the frontend with the following data: -component: ManagementDevices

    • props:

    props = {
    "devices": # List of devices,
    "count": # Total number of devices,
    "paginateBy": # Number of devices displayed per page,
    "pages": # Number of pages needed to display the total,
    "currentPage": # Current page,
}

delete_device

View to delete a device from the authorized user management. The user is redirected to the device_list view of the management**.** To access this view the user must be logged in and belong to the management. group

  • URL: /manage/device/delete/<device_id>

  • GET: Receives the id of the device as a parameter to eliminate it from the WhiteListIpAuthorization model.

global_settings_scripts

View that provides the frontend with the necessary data to set the custom scripts that will be inserted in the base.html. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/scripts

  • GET: Provides the frontend with the data: -component:SystemSettingsScripts

    • props:

    props = {
"header": # Script to be inserted in the header of the base.html,
"footer": # Script to be inserted at the end of the body tag,
"body": # Script to be inserted at the beginning of the body tag,
}

  • POST: Validates the header, footer, body fields and changes the header_scripts, footer_scripts and body_scripts fields of the GlobalSettings model

global_settings_social_connections

View that lists the configured authentication providers. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/social/connections

  • GET: Provides the frontend with the following data: -component: SystemSettingsSocialConnection

    • props:

    props = {
"socialApps": # List of authenticator app providers
}

global_settings_create_social_app

View to set a new authentication provider. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/social/connections/create

  • GET: Provides the frontend with the required data:

    • component: SystemSettingsCreateSocialConnection

    • props:

    props = {
"availableProviders": # Dictionary with the providers enabled,
}

  • POST: Validates the fields required for the creation and configuration of a new authentication provider. Once created, it is redirected to the global_settings_social_connections. view

global_settings_edit_social_app

View to modify an authentication provider configured in the application. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/social/connections/edit/<social_id>

  • GET: Provides the frontend with the data: -component:SystemSettingsEditSocialConnection

    • props:

    props = {
"availableProviders": # Dictionary with the providers enabled,
"socialApp": # Details of the indicated provider,
}

  • POST: Validates the fields required for the modification of the supplier. Once modified, it redirects to the global_settings_social_connections. view

global_settings_delete_social_app

View to delete a registered authentication provider in the app. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/social/connections/delete/<social_id>

  • GET: Eliminates the record of the provider indicated in social_id. Redirects to the global_settings_social_connections. view

system_active_email_provider

View that allows the manager to activate/deactivate the sending of emails through a third-party service provider; then it is redirected to the global_settings_general view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/security/active/email_provider

  • GET: Changes the value to its opposite in the active_email_provider field of the GlobalSettings model.

email_providers_list

View to list the email providers. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider

  • GET: Provides the frontend with the following data: -component: EmailProviders

    • props:

    props = {
"emailProviders": # List of registered email providers,
"availableLanguages": # Dictionary of available languages,
}

email_providers_create

View to set up a new email provider. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider/create

  • GET: Provides the frontend with the required data: -component: EmailProviderCreate

    • props:

    props = {
"availableProviders": # Dictionary with the providers enabled,
}

  • POST: Validates the fields required for the creation and configuration of a new email provider. Once created, it is redirected to the email_providers_list. view

email_provider_edit

View to modify an email provider registered in the application. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider/edit/<email_provider_id>/

  • GET: Provides the frontend with the data: -component: EmailProviderEdit

    • props:

    props = {
"emailProvider": # Detail of the email provider,
"availableProviders": # Dictionary with the providers enabled,
}

  • POST: Validates the fields required for the modification of the supplier. Once modified, it redirects to the email_providers_list. view

email_provider_delete

View to delete an email provider registered in the app. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider/delete/<email_provider_id>/

  • GET: Eliminates the record of the provider indicated in email_provider_id. Redirects to the email_providers_list. view

provider_templates_list

View to list the templates associated with a provider for sending emails. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider/template/<provider_id>/

  • GET: Provides the frontend with the following data: -component: ProviderTemplates

    • props:

    props = {
"templates": # List of templates associated with the provider,
"availableLanguages": # Dictionary of available languages,
}

provider_template_edit

View to modify the template of an email provider registered in the application. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider/template/edit/<template_id>/

  • GET: Provides the frontend with the data: -component: ProviderTemplateEdit

    • props:

    props = {
"template": # Details of the template,
"availableProviders": # Dictionary with the providers enabled,
}

  • POST: Validates the fields required for the modification of the template. Once modified, it redirects to the provider_templates_list. view

provider_template_create

View to set a new template for an email provider. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider/template/create

  • GET: Provides the frontend with the required data: -component: ProviderTemplateCreate

    • props:

    props = {
"availableProviders": # Dictionary of email delivery providers,
"availableProviders": # Dictionary with the providers enabled,
}

  • POST: Validates the fields required for the creation and configuration of a new template for an email delivery provider. Once created, it is redirected to the provider_templates_list. view

provider_template_delete

View to delete an email delivery provider template registered in the app. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/email/provider/template/delete/<template_id>/

  • GET: Eliminates the record of the provider indicated in template_id. Redirects to the provider_templates_list. view

system_active_registration

View that allows the manager to activate/deactivate the user registration; then it is redirected to the global_settings_general view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/active/registration

  • GET: Change the value to its opposite in the active_registration field of the GlobalSettings model.

system_active_captcha

View that allows the manager to activate/deactivate the captcha module; then it is redirected to the global_settings_security view. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/active/registration

  • GET: Change the value to its opposite in the active_captcha field of the GlobalSettings model.

global_settings_provider_captcha

View that allows you to create or edit a captcha provider in the application. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/provider/captcha

  • GET: Provides the frontend with the data: -component:SystemSettingsCaptcha

    • props:

    props = {
"captcha": # Captcha provider detail,
"availableProviders": # Available captcha providers,
}

  • POST: Validates the fields to create or modify a record in the CaptchaSettings model.

delete_provider_captcha

View to delete a captcha provider registered in the app. To access this view, the user must be logged in and belong to the management. group.

  • URL: /manage/settings/global/provider/captcha/delete/

  • GET: Eliminates the record of the registered provider. Redirects to the global_settings_provider_captcha. view