Class: LWS::Auth::User

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::Auth::User

Defined in:

lib/lws/apps/auth.rb

Overview

The user class

This class is a nested/associated class of Account or Token only! It cannot be accessed directly.

Instance Attribute Summary

• #account ⇒ Account

  The account that the user belongs to.

• #account_id ⇒ Integer

  The ID of the account that the user belongs to.

• #auth_provider ⇒ String

  The name of the authentication provider.

• #email ⇒ String

  The email address of the user.

• #mfa_enabled ⇒ Boolean

  Whether MFA (multi-factor authentication) is enabled for the user.

• #mfa_verified ⇒ Boolean

  Whether MFA (multi-factor authentication) has been verified for the user.

• #oauth_expires_at ⇒ String^?

  The timestamp of when the OAuth token of the user expires.

• #password_digest ⇒ String^?

  The digested version of the password of the user.

• #password_expires_at ⇒ String^?

  The timestamp on which the password of the user expires.

• #use_for_communication ⇒ Boolean

  Whether the email address (see #email) of the user is/will be used to send messages/announcements.

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#deep_dup, #dig, #reload, #rollback, #save

Instance Attribute Details

#account ⇒ Account

Returns the account that the user belongs to.

Returns:

• (Account) —

  the account that the user belongs to

# File 'lib/lws/apps/auth.rb', line 408

belongs_to :account

#account_id ⇒ Integer

Returns the ID of the account that the user belongs to.

Returns:

• (Integer) —

  the ID of the account that the user belongs to

# File 'lib/lws/apps/auth.rb', line 412

attribute :account_id

#auth_provider ⇒ String

Returns the name of the authentication provider.

Returns:

• (String) —

  the name of the authentication provider

# File 'lib/lws/apps/auth.rb', line 416

attribute :auth_provider

#email ⇒ String

Returns the email address of the user.

Returns:

• (String) —

  the email address of the user

# File 'lib/lws/apps/auth.rb', line 420

attribute :email

#mfa_enabled ⇒ Boolean

Returns whether MFA (multi-factor authentication) is enabled for the user.

Returns:

• (Boolean) —

  whether MFA (multi-factor authentication) is enabled for the user

# File 'lib/lws/apps/auth.rb', line 425

attribute :mfa_enabled

#mfa_verified ⇒ Boolean

Returns whether MFA (multi-factor authentication) has been verified for the user.

Returns:

• (Boolean) —

  whether MFA (multi-factor authentication) has been verified for the user

# File 'lib/lws/apps/auth.rb', line 430

attribute :mfa_verified

#oauth_expires_at ⇒ String^?

Returns the timestamp of when the OAuth token of the user expires.

Returns:

• (String, nil) —

  the timestamp of when the OAuth token of the user expires

# File 'lib/lws/apps/auth.rb', line 435

attribute :oauth_expires_at

#password_digest ⇒ String^?

Returns the digested version of the password of the user. (Can be nil if the authentication provider (see #auth_provider) is not “lws”.).

Returns:

• (String, nil) —

  the digested version of the password of the user. (Can be nil if the authentication provider (see #auth_provider) is not “lws”.)

# File 'lib/lws/apps/auth.rb', line 441

attribute :password_digest

#password_expires_at ⇒ String^?

Returns the timestamp on which the password of the user expires.

Returns:

• (String, nil) —

  the timestamp on which the password of the user expires.

# File 'lib/lws/apps/auth.rb', line 446

attribute :password_expires_at

#use_for_communication ⇒ Boolean

Returns whether the email address (see #email) of the user is/will be used to send messages/announcements.

Returns:

• (Boolean) —

  whether the email address (see #email) of the user is/will be used to send messages/announcements

# File 'lib/lws/apps/auth.rb', line 451

attribute :use_for_communication