gazette.views.users
===================

.. py:module:: gazette.views.users


Functions
---------

.. autoapisummary::

   gazette.views.users.view_users
   gazette.views.users.create_user
   gazette.views.users.edit_user
   gazette.views.users.delete_user
   gazette.views.users.view_user_sessions
   gazette.views.users.clear_user_sessions
   gazette.views.users.export_users


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

.. py:function:: view_users(self: onegov.user.UserCollection, request: onegov.gazette.request.GazetteRequest) -> onegov.core.types.RenderData

   View the users.

   Publishers can see editors, admins can see editors and publishers. Admins
   are never shown.



.. py:function:: create_user(self: onegov.user.UserCollection, request: onegov.gazette.request.GazetteRequest, form: onegov.gazette.forms.UserForm) -> onegov.core.types.RenderData | webob.Response

   Create a new publisher or editor.

   This view is visible for admins and publishers.



.. py:function:: edit_user(self: onegov.user.User, request: onegov.gazette.request.GazetteRequest, form: onegov.gazette.forms.UserForm) -> onegov.core.types.RenderData | webob.Response

   Edit the role, name and email of a user.

   Publishers may only edit members. Admins can not be edited.



.. py:function:: delete_user(self: onegov.user.User, request: onegov.gazette.request.GazetteRequest, form: onegov.gazette.forms.EmptyForm) -> onegov.core.types.RenderData | webob.Response

   Delete a user.

   Publishers may only edit members. Admins can not be deleted.



.. py:function:: view_user_sessions(self: onegov.user.UserCollection, request: onegov.gazette.request.GazetteRequest) -> onegov.core.types.RenderData

   View all open browser sessions.

   This view is only visible by an admin.



.. py:function:: clear_user_sessions(self: onegov.user.User, request: onegov.gazette.request.GazetteRequest, form: onegov.gazette.forms.EmptyForm) -> onegov.core.types.RenderData | webob.Response

   Closes all open browser sessions.

   This view is only visible by an admin.



.. py:function:: export_users(self: onegov.user.UserCollection, request: onegov.gazette.request.GazetteRequest, form: onegov.gazette.forms.user.ExportUsersForm) -> onegov.core.types.RenderData | morepath.request.Response

   Export all users as XLSX. The exported file can be re-imported
   using the import-editors command line command.