Skip to content

Latest commit

 

History

History
129 lines (81 loc) · 3.3 KB

api.rst

File metadata and controls

129 lines (81 loc) · 3.3 KB

API

Core

.. autoclass:: flask_security.core.Security
    :members:


.. data:: flask_security.core.current_user

   A proxy for the current user.

Protecting Views

.. autofunction:: flask_security.decorators.login_required


.. autofunction:: flask_security.decorators.roles_required


.. autofunction:: flask_security.decorators.roles_accepted


.. autofunction:: flask_security.decorators.http_auth_required


.. autofunction:: flask_security.decorators.auth_token_required

User Object Helpers

.. autoclass:: flask_security.core.UserMixin
   :members:


.. autoclass:: flask_security.core.RoleMixin
   :members:


.. autoclass:: flask_security.core.AnonymousUser
   :members:

Datastores

.. autoclass:: flask_security.datastore.UserDatastore
    :members:


.. autoclass:: flask_security.datastore.SQLAlchemyUserDatastore
    :members:
    :inherited-members:


.. autoclass:: flask_security.datastore.MongoEngineUserDatastore
    :members:
    :inherited-members:


.. autoclass:: flask_security.datastore.PeeweeUserDatastore
    :members:
    :inherited-members:


.. autoclass:: flask_security.datastore.PonyUserDatastore
    :members:
    :inherited-members:

Utils

.. autofunction:: flask_security.utils.login_user


.. autofunction:: flask_security.utils.logout_user


.. autofunction:: flask_security.utils.get_hmac


.. autofunction:: flask_security.utils.verify_password


.. autofunction:: flask_security.utils.verify_and_update_password


.. autofunction:: flask_security.utils.encrypt_password


.. autofunction:: flask_security.utils.hash_password


.. autofunction:: flask_security.utils.url_for_security


.. autofunction:: flask_security.utils.get_within_delta


.. autofunction:: flask_security.utils.send_mail


.. autofunction:: flask_security.utils.get_token_status

Signals

See the Flask documentation on signals for information on how to use these signals in your code.

See the documentation for the signals provided by the Flask-Login and Flask-Principal extensions. In addition to those signals, Flask-Security sends the following signals.

.. data:: user_registered

   Sent when a user registers on the site. In addition to the app (which is the
   sender), it is passed `user` and `confirm_token` arguments.


.. data:: user_confirmed

   Sent when a user is confirmed. In addition to the app (which is the
   sender), it is passed a `user` argument.


.. data:: confirm_instructions_sent

   Sent when a user requests confirmation instructions. In addition to the app
   (which is the sender), it is passed a `user` argument.


.. data:: login_instructions_sent

   Sent when passwordless login is used and user logs in. In addition to the app
   (which is the sender), it is passed `user` and `login_token` arguments.


.. data:: password_reset

   Sent when a user completes a password reset. In addition to the app (which is
   the sender), it is passed a `user` argument.


.. data:: password_changed

   Sent when a user completes a password change. In addition to the app (which is
   the sender), it is passed a `user` argument.


.. data:: reset_password_instructions_sent

   Sent when a user requests a password reset. In addition to the app (which is
   the sender), it is passed `user` and `token` arguments.