user.cli
========

.. py:module:: user.cli

.. autoapi-nested-parse::

   Provides commands used to manage users. 



Attributes
----------

.. autoapisummary::

   user.cli.cli


Functions
---------

.. autoapisummary::

   user.cli.add
   user.cli.delete
   user.cli.exists
   user.cli.activate
   user.cli.deactivate
   user.cli.logout
   user.cli.logout_all
   user.cli.list
   user.cli.change_password
   user.cli.change_yubikey
   user.cli.change_mtan
   user.cli.change_totp
   user.cli.transfer_yubikey
   user.cli.change_role
   user.cli.list_sessions


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

.. py:data:: cli

.. py:function:: add(role: str, username: str, password: str | None, yubikey: str | None, no_prompt: bool, realname: str | None, phone_number: str | None) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Adds a user with the given name to the database. 


.. py:function:: delete(username: str) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Removes the given user from the database. 


.. py:function:: exists(username: str, recursive: bool) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Returns 0 if the user exists, 1 if it doesn't when recursive equals
   to False. If the recursive flag is set, it will loop over all schemas
   and print the result for each schema without return value.


.. py:function:: activate(username: str) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Activates the given user. 


.. py:function:: deactivate(username: str) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Deactivates the given user. 


.. py:function:: logout(username: str) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Logs out the given user on all sessions. 


.. py:function:: logout_all() -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Logs out all users on all sessions. 


.. py:function:: list(active_only: bool, inactive_only: bool, sources: bool) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Lists all users. 


.. py:function:: change_password(username: str, password: str | None) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Changes the password of the given username. 


.. py:function:: change_yubikey(username: str, yubikey: str | None) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Changes the yubikey of the given username. 


.. py:function:: change_mtan(username: str, phone_number: str | None) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Changes the yubikey of the given username. 


.. py:function:: change_totp(username: str, secret: str | None, generate: bool) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Changes the yubikey of the given username. 


.. py:function:: transfer_yubikey(source: str, target: str) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Transfers the Yubikey from one user to another. 


.. py:function:: change_role(username: str, role: str) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Changes the role of the given username. 


.. py:function:: list_sessions() -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Lists all sessions of all users.