Models
******

Flask-Security assumes you'll be using libraries such as SQLAlchemy,
MongoEngine, Peewee or PonyORM to define a *User* and *Role* data
model. The fields on your models must follow a particular convention
depending on the functionality your app requires. Aside from this,
you're free to add any additional fields to your model(s) if you want.

As more features are added to Flask-Security, the list of required
fields and tables grow. As you use these features, and therefore
require these fields and tables, database migrations are required;
which are a bit of a pain. To make things easier - Flask-Security
includes mixins that contain ALL the fields and tables required for
all features. They also contain various *best practice* fields - such
as update and create times. These mixins can be easily extended to add
any sort of custom fields and can be found in the *models* module
(today there is just one for using Flask-SQLAlchemy).

The provided models are versioned since they represent actual DB
models, and any changes require a schema migration (and perhaps a data
migration). Applications must specifically import the version they
want (and handle any required migration).

Your *User* model needs a Primary Key - Flask-Security doesn't
actually reference this - so it can be any name or type your
application needs. It should be used in the foreign relationship
between *User* and *Role*.

At the bare minimum your *User* and *Role* model should include the
following fields:

**User**

* primary key

* "email" (for most features - unique, non-nullable)

* "password" (non-nullable)

* "active" (boolean, non-nullable)

* "fs_uniquifier" (string, 64 bytes, unique, non-nullable)

**Role**

* primary key

* "name" (unique, non-nullable)

* "description" (string)


Additional Functionality
========================

Depending on the application's configuration, additional fields may
need to be added to your *User* model.


Confirmable
-----------

If you enable account confirmation by setting your application's
*SECURITY_CONFIRMABLE* configuration value to *True*, your *User*
model will require the following additional field:

* "confirmed_at" (datetime)


Trackable
---------

If you enable user tracking by setting your application's
*SECURITY_TRACKABLE* configuration value to *True*, your *User* model
will require the following additional fields:

* "last_login_at" (datetime)

* "current_login_at" (datetime)

* "last_login_ip" (string)

* "current_login_ip" (string)

* "login_count" (integer)


Two_Factor
----------

If you enable two-factor by setting your application's
*SECURITY_TWO_FACTOR* configuration value to *True*, your *User* model
will require the following additional fields:

* "tf_totp_secret" (string, 255 bytes, nullable)

* "tf_primary_method" (string)

If you include 'sms' in *SECURITY_TWO_FACTOR_ENABLED_METHODS*, your
*User* model will require the following additional field:

* "tf_phone_number" (string, 255 bytes, nullable)


Unified Sign In
---------------

If you enable unified sign in by setting your application's
"SECURITY_UNIFIED_SIGNIN" configuration value to *True*, your *User*
model will require the following additional fields:

* "us_totp_secrets" (an arbitrarily long Text field)

If you include 'sms' in "SECURITY_US_ENABLED_METHODS", your *User*
model will require the following additional field:

* "us_phone_number" (string)


Separate Identity Domains
~~~~~~~~~~~~~~~~~~~~~~~~~

If you want authentication tokens to not be invalidated when the user
changes their password add the following to your *User* model:

* "fs_token_uniquifier" (string, 64 bytes, unique, non-nullable)


Username
~~~~~~~~

If you set "SECURITY_USERNAME_ENABLE" to *True*, then your *User*
model requires the following additional field:

* "username" (string, 64 bytes, unique, nullable)


Permissions
-----------

If you want to protect endpoints with permissions, and assign
permissions to roles that are then assigned to users, the "Role" model
requires:

* "permissions" (UnicodeText)


Custom User Payload
-------------------

If you want a custom payload for JSON API responses, define the method
*get_security_payload* in your User model. The method must return a
serializable object:

   class User(db.Model, UserMixin):
       id = db.Column(db.Integer, primary_key=True)
       email = TextField()
       password = TextField()
       active = BooleanField(default=True)
       confirmed_at = DateTimeField(null=True)
       name = db.Column(db.String(80))

       # Custom User Payload
       def get_security_payload(self):
           rv = super().get_security_payload()
           # :meth:`User.calc_username`
           rv["username"] = self.calc_username()
           rv["confirmation_needed"] = self.confirmed_at is None
           return rv
