.. index:: 
  !UserAuthentication Class

.. _id3_bioseal_user_authentication_class:

===============================================================================
UserAuthentication Class
===============================================================================

Namespace: :ref:`id3.Bioseal<reference_bioseal>`

.. toctree::
  :hidden:

  method<method>
  passwordFieldName<password_field_name>
  passwordHashAlgorithm<password_hash_algorithm>


Definition
----------
.. line-block::
    Represents the user authentication parameters.


Properties
----------

.. list-table:: 
  :width: 100%
  :widths: 30 5 65
  :header-rows: 1

  * - Name
    - Type
    - Description
  * - :ref:`method<id3_bioseal_user_authentication_method_class_member>`
    - :ref:`UserAuthenticationMethod<id3_bioseal_user_authentication_method_enum>`
    - The user authentication method.
  * - :ref:`passwordFieldName<id3_bioseal_user_authentication_password_field_name_class_member>`
    - string
    - The name of the payload field containing the password value.
  * - :ref:`passwordHashAlgorithm<id3_bioseal_user_authentication_password_hash_algorithm_class_member>`
    - string
    - The hash algorithm used to protect the password value. Possible values are: Sha256, Sha384, Sha512.
