.. _tokeninfo:

Token info
----------

.. index::
   Tokeninfo

When you select one token, you can choose "Tokeninfo" to view details about the selected token.

In the GTK client you can choose Tokeninfo by right clicking the token. In the Web UI you can
click the button above the token view tab.

.. figure:: images/tokeninfo.png

   *Detailed information about the token can be viewed in the tokeninfo dialog*
   
The displayed information reflect the database token table.

``TokenId``
   This is the internal database id of the token.
   
``TokenInfo``
   This is a field that holds many additional information like the type of the hash library used with the 
   OATH algorithm or special information about timebased TOTP tokens.
   
   Here you will also find information, how often a token was successfully used to authenticate and how
   often a user tried to authenticate with this token.
   
   .. index::
      Validity period
      
   Also in this field the validity period of the token is stored.   
   The validity period determines till when a token may be used and starting from which date a token
   may be used. E.g. this is used for the lost tokens (see :ref:`losttoken`).
   
``OtpLen``
   This is the length of the OTP value. The OTP value will be truncated to this length.
   Also, during authentication this value is used to split the entered credential into
   the OTP PIN and the OTP value.
   
``TokenType``
   This is the internal type of the token. The type determines the TokenClass, that will be used to 
   calculate the OTP value.
   
   The list of the supported types is constantly increasing. Those types can be: hmac, totp, motp, sms, 
   spass, radius, remote, vasco... 
   
   .. note:: The type only specifies the type of algorithm to validate the OTP value or the way to 
      distribute the OTP value. So the type "hmac" can be an SafeNet eToken PASS, a Feitian Token, a
      Yubikey and any other softtoken, that uses the hmac (HOTP) algorithm.
      
``TokenSerialnumber``
   This is a *unique* serial number of this very token.
   
   The serial number also usually indicates the type of the token.
   
   For OATH compliant tokens the first two letters specify the vendor. 
   
   .. note:: LSE's own tokens will always start with "LS".
   
   The next two letters may specify the type of the token like:
   
       * LSSP: LSE Simple Pass token
       * LSRE: LSE REmote token
       * LSRA: LSE RAdius token
       * LSOC: LSE OCra token
       * LSSM: LSE SMs token
   
``CountWindow``
   This is the window where the LinOTP server searches a matching counter to validate the OTP value.
   
``MaxFail``
   This settings corresponds with the ``Failcount``. The ``Failcount`` gets increased, when the user
   fails to authenticate with this token.
   When the ``Failcount`` reaches ``MaxFail`` the user can not authenticate with this token anymore.
   (see :ref:`resetfailcounter`)
   
``User.description``
   is a variable field that gets blended in from the UserIdResolver. The contents depends 
   on the specific UserIdResolver implementation.
   
``Realm names``
   This is the list of realms in which the token is put.
   
``count``
   This is the counter of event based tokens.
   
``User.username``
   This is the username (loginname) of the user to whom the token is assigned.
   
``Syncwindow``
   When doing a resync (either manually or automatic) the fitting counter is searched for in
   this window.
   
``Failcount``
   see ``MaxFail``
   
``TokenDesc``
   This is the token description. Using the API it is possible to set the description to some thing
   of your needs. This is usually set to some kinds like "web enrolled", "temporary replacement" or
   if it is an SMS token to the mobile phone number.
   
   This field has no functional purpose.
   
``User.userid``
   This is the unique identifier to find the user in the given UserIdResolver.
   
``IdResolver``
   This is the UserIdResolver, where to user, to whom the token is assigned, is located.
   
``Userid``
   This is the unique identifier to find the user in the given UserIdResolver.
   
``IsActive``
   This is the flag that indicates it the token is enabled or disabled.