.. index::
    single: Glossary

.. _glossary:

Glossary
========

Even though :tirreno:`Tirreno` is a system utilizing numerous
sophisticated techniques inside, on the outside it is designed to be an
approachable solution. Accordingly, in this user guide, we make an
effort to introduce as little special terminology and concepts as
possible without compromising the guide’s applicability and
comprehensiveness for users of the system.

Following is a list of terms that may come in handy when acquainting
oneself with :tirreno:`Tirreno`. The terms are listed in the order
corresponding to the :ref:`workflow of the system <system-workflow>`.

.. glossary::

    Community Version

      An open-source version of :tirreno:`Tirreno`: platform for preventing
      fraud, account takeovers, and abuse.

    Enterprise Version

      A commercially licensed version of :tirreno:`Tirreno`. It includes
      the features of the :term:`Community version` and grants access to
      the :term:`Enrichment API`, which upgrades :tirreno:`Tirreno` to a
      risk management and fraud prevention system. The :ref:`Enrichment
      Subscription <enrichment-subscription>` section outlines the steps
      for enabling the extended capabilities.

    Enrichment API

      *Enterprise version only*. The :tirreno:`Tirreno` API that
      supplies extended information on IP addresses, email addresses,
      domains, and phone numbers.

    Enrichment key

      *Enterprise version only*. A key that grants access to the
      :term:`Enrichment API`. It is generated once the :term:`Enterprise
      version` subscription is activated.

    Client

      A digital platform that sends :term:`user` request data to
      :tirreno:`Tirreno`.

    User

      An actor that sends requests to the :term:`client`.

    Sensor

      A :tirreno:`Tirreno`-provided application programming interface
      (API) that enables the collection, enrichment, and management of
      information. The sensor is bundled with the :tirreno:`Tirreno`
      source code in the “/sensor” directory. The default sensor URL
      is ``https://your-domain.example/sensor``.

    Integration Script

      Code that sends information from a :term:`client` platform to the
      :term:`sensor`.

    Tracking Code

      An account-unique value that authorizes access to the
      :tirreno:`Tirreno` API. This value must be included in the
      `Api-Key` header of each API request.

    Event

      A :term:`user` request registered with the :tirreno:`Tirreno`’s
      API (see :term:`sensor`). May also refer to the reported data
      associated with an event.

    Rules Engine

      A set of conditions for machine-performed analysis of
      :term:`events<event>`.

    Rule

      One of the conditions utilized by the :term:`rules engine`.

    Trust Score

      A :term:`user`-specific value. It is calculated by the
      :term:`rules engine` based on the reported :term:`events<event>`.
      The trust score value ranges from 0 to 99. :term:`Users<user>`
      with fewer :term:`warning signals<warning signal>` detected have
      higher scores. A low trust score denotes a significant risk of
      fraudulent :term:`user` activity.

    Console

      A web-accessible user interface that outputs the intelligence for
      manual review and enables control over the alterable parts of
      :tirreno:`Tirreno`.

    Operator

      A person that performs tuning of the :tirreno:`Tirreno` system and
      manual review of the collected intelligence via :term:`console`.

    Warning Signal

      An abnormality in :term:`events<event>` or :term:`user` data,
      potentially indicating a fraudulent activity. Warning signals are
      commonly marked with colour throughout the :term:`console`.

    Resource

      An element of a :term:`client` platform that can be accessed by a
      :term:`user`. For example, this can be a web page “/users/login”
      or “/index.html”.

    Identity

      A basic piece of information related to a :term:`user`, such as an
      email address, IP address, phone number, etc.