:tocdepth: 3

:py:mod:`gws.plugin.account.account_action`
===========================================

.. py:module:: gws.plugin.account.account_action

.. autoapi-nested-parse::

   User account action.



**Source code:** :source:`gws.plugin.account.account_action<gws/plugin/account/account_action.py>`



Module Contents
---------------



.. py:class:: Config


   Bases: :py:obj:`gws.base.action.Config`

   User Account action. (added in 8.1)


.. py:class:: MfaProps(*args, **kwargs)


   Bases: :py:obj:`gws.Data`

   Basic data object.

   This object can be instantiated by passing one or or ``dict`` arguments
   and/or keyword args. All dicts keys and keywords become attributes of the object.

   Accessing an undefined attribute returns ``None`` and no error is raised,
   unless the attribute name starts with an underscore.

   .. py:attribute:: index
      :type:  int

   .. py:attribute:: qrCode
      :type:  str

   .. py:attribute:: title
      :type:  str


.. py:class:: Object


   Bases: :py:obj:`gws.base.action.Object`

   .. py:attribute:: h
      :type:  gws.plugin.account.helper.Object

   .. py:method:: configure()

   .. py:method:: get_account_by_tc(tc, category, expected_status)

   .. py:method:: mfa_props(account: dict, mfa_secret)

   .. py:method:: onboarding_save_mfa(req: gws.WebRequester, p: OnboardingSaveMfaRequest) -> OnboardingSaveMfaResponse

   .. py:method:: onboarding_save_password(req: gws.WebRequester, p: OnboardingSavePasswordRequest) -> OnboardingSavePasswordResponse

   .. py:method:: onboarding_start(req: gws.WebRequester, p: OnboardingStartRequest) -> OnboardingStartResponse


.. py:class:: OnboardingSaveMfaRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: mfaIndex
      :type:  Optional[int]

   .. py:attribute:: tc
      :type:  str


.. py:class:: OnboardingSaveMfaResponse(*args, **kwargs)


   Bases: :py:obj:`gws.Response`

   Command response.

   .. py:attribute:: complete
      :type:  bool

   .. py:attribute:: completionUrl
      :type:  str


.. py:class:: OnboardingSavePasswordRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: email
      :type:  str

   .. py:attribute:: password1
      :type:  str

   .. py:attribute:: password2
      :type:  str

   .. py:attribute:: tc
      :type:  str


.. py:class:: OnboardingSavePasswordResponse(*args, **kwargs)


   Bases: :py:obj:`gws.Response`

   Command response.

   .. py:attribute:: complete
      :type:  bool

   .. py:attribute:: completionUrl
      :type:  str

   .. py:attribute:: mfaList
      :type:  list[MfaProps]

   .. py:attribute:: ok
      :type:  bool

   .. py:attribute:: tc
      :type:  str


.. py:class:: OnboardingStartRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: tc
      :type:  str


.. py:class:: OnboardingStartResponse(*args, **kwargs)


   Bases: :py:obj:`gws.Response`

   Command response.

   .. py:attribute:: tc
      :type:  str


.. py:class:: Props


   Bases: :py:obj:`gws.base.action.Props`