Struct Account 

pub struct Account {
    pub id: String,
    pub email: String,
    pub email_normalised: String,
    pub password: String,
    pub disabled: bool,
    pub verification: EmailVerification,
    pub password_reset: Option<PasswordReset>,
    pub deletion: Option<DeletionInfo>,
    pub lockout: Option<Lockout>,
    pub mfa: MultiFactorAuthentication,
}

Account model

Fields

id: String

Unique Id

email: String

User’s email

email_normalised: String

Normalised email

(see https://github.com/insertish/authifier/#how-does-authifier-work)

password: String

Argon2 hashed password

disabled: bool

Whether the account is disabled

verification: EmailVerification

Email verification status

password_reset: Option<PasswordReset>

Password reset information

deletion: Option<DeletionInfo>

Account deletion information

lockout: Option<Lockout>

Account lockout

mfa: MultiFactorAuthentication

Multi-factor authentication information

Implementations

impl Account

pub fn apply_options(&mut self, optional_struct: PartialAccount)

impl Account

pub async fn save(&self, db: &Database) -> Result<()>

Save model

pub async fn new( db: &Database, email: String, plaintext_password: String, verify_email: bool, ) -> Result<Account>

Create a new account

pub async fn create_session( &self, db: &Database, name: String, ) -> Result<Session>

Create a new session

pub async fn start_email_verification(&mut self, db: &Database) -> Result<()>

Send account verification email

pub async fn start_email_move( &mut self, db: &Database, new_email: String, ) -> Result<()>

Send account verification to new email

pub async fn start_password_reset( &mut self, db: &Database, existing_account: bool, ) -> Result<()>

Send password reset email

pub async fn start_account_deletion(&mut self, db: &Database) -> Result<()>

Begin account deletion process by sending confirmation email

If email verification is not on, the account will be marked for deletion instantly

pub fn verify_password(&self, plaintext_password: &str) -> Result<()>

Verify a user’s password is correct

pub async fn consume_mfa_response( &mut self, db: &Database, response: MFAResponse, ticket: Option<MFATicket>, ) -> Result<()>

Validate an MFA response

pub async fn delete_all_sessions( &self, db: &Database, exclude_session_id: Option<String>, ) -> Result<()>

Delete all sessions for an account

pub async fn disable(&mut self, db: &Database) -> Result<()>

Disable an account

pub async fn schedule_deletion(&mut self, db: &Database) -> Result<()>

Schedule an account for deletion

pub async fn mark_deleted(&mut self, db: &Database) -> Result<()>

Removes all information from the account and marks it as fully deleted

Trait Implementations

impl Clone for Account

fn clone(&self) -> Account

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Account

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Account

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Account

impl From<Account> for AccountInfo

fn from(item: Account) -> Self

Converts to this type from the input type.

impl PartialEq for Account

fn eq(&self, other: &Account) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Account

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Account